"""Request Body Schemas for API Tools

DO NOT EDIT THIS MODULE DIRECTLY.

THIS MODULE WAS AUTO-GENERATED AND CONTAINS OpenAPI REQUEST BODY SCHEMAS
FOR TOOLS WITH COMPLEX REQUEST BODIES. ANY CHANGES TO THIS MODULE WILL
BE OVERWRITTEN BY THE TRANSPILER.
"""

from typing import Any

REQUEST_BODY_SCHEMAS: dict[str, Any] = {
    "CREATEBOOKING": '{"type": "object", "x-release-status": "PUBLIC", "required": ["booking"], "properties": {"idempotency_key": {"type": "string", "description": "A unique key to make this request an idempotent operation.", "maxLength": 255}, "booking": {"type": "object", "description": "Represents a booking as a time-bound service contract for a seller\'s staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique ID of this object representing a booking.", "maxLength": 36, "readOnly": true}, "version": {"type": "integer", "description": "The revision number for the booking used for optimistic concurrency."}, "status": {"type": "string", "enum": ["PENDING", "CANCELLED_BY_CUSTOMER", "CANCELLED_BY_SELLER", "DECLINED", "ACCEPTED", "NO_SHOW"], "x-enum-elements": [{"name": "PENDING", "description": "An unaccepted booking. It is visible to both sellers and customers."}, {"name": "CANCELLED_BY_CUSTOMER", "description": "A customer-cancelled booking. It is visible to both the seller and the customer."}, {"name": "CANCELLED_BY_SELLER", "description": "A seller-cancelled booking. It is visible to both the seller and the customer."}, {"name": "DECLINED", "description": "A declined booking. It had once been pending, but was then declined by the seller."}, {"name": "ACCEPTED", "description": "An accepted booking agreed to or accepted by the seller."}, {"name": "NO_SHOW", "description": "A no-show booking. The booking was accepted at one time, but have now been marked as a no-show by\nthe seller because the client either missed the booking or cancelled it without enough notice."}], "description": "Supported booking statuses.", "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the creation time of this booking.", "readOnly": true}, "updated_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the most recent update time of this booking.", "readOnly": true}, "start_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the starting time of this booking.", "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.", "maxLength": 32, "nullable": true}, "customer_id": {"type": "string", "description": "The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.", "maxLength": 192, "nullable": true}, "customer_note": {"type": "string", "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.", "maxLength": 4096, "nullable": true}, "seller_note": {"type": "string", "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\nThis field should not be visible to customers.", "maxLength": 4096, "nullable": true}, "appointment_segments": {"type": "array", "items": {"type": "object", "description": "Defines an appointment segment of a booking.", "x-release-status": "PUBLIC", "required": ["team_member_id"], "properties": {"duration_minutes": {"type": "integer", "description": "The time span in minutes of an appointment segment.", "maximum": 1500, "nullable": true}, "service_variation_id": {"type": "string", "description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.", "maxLength": 36, "nullable": true}, "team_member_id": {"type": "string", "description": "The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment.", "minLength": 1, "maxLength": 32}, "service_variation_version": {"type": "integer", "description": "The current version of the item variation representing the service booked in this segment.", "format": "int64", "nullable": true}, "intermission_minutes": {"type": "integer", "description": "Time between the end of this segment and the beginning of the subsequent segment.", "readOnly": true}, "any_team_member": {"type": "boolean", "description": "Whether the customer accepts any team member, instead of a specific one, to serve this segment.", "readOnly": true}, "resource_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the seller-accessible resources used for this appointment segment.", "readOnly": true}}}, "description": "A list of appointment segments for this booking.", "nullable": true}, "transition_time_minutes": {"type": "integer", "description": "Additional time at the end of a booking.\nApplications should not make this field visible to customers of a seller.", "readOnly": true}, "all_day": {"type": "boolean", "description": "Whether the booking is of a full business day.", "readOnly": true}, "location_type": {"type": "string", "enum": ["BUSINESS_LOCATION", "CUSTOMER_LOCATION", "PHONE"], "x-enum-elements": [{"name": "BUSINESS_LOCATION", "description": "The service is provided at a seller location."}, {"name": "CUSTOMER_LOCATION", "description": "The service is provided at a customer location."}, {"name": "PHONE", "description": "The service is provided over the phone."}], "description": "Supported types of location where service is provided.", "x-release-status": "PUBLIC"}, "creator_details": {"type": "object", "description": "Information about a booking creator.", "x-release-status": "PUBLIC", "properties": {"creator_type": {"type": "string", "enum": ["TEAM_MEMBER", "CUSTOMER"], "x-enum-elements": [{"name": "TEAM_MEMBER", "description": "The creator is of the seller type."}, {"name": "CUSTOMER", "description": "The creator is of the buyer type."}], "description": "Supported types of a booking creator.", "x-release-status": "PUBLIC"}, "team_member_id": {"type": "string", "description": "The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\nAccess to this field requires seller-level permissions.", "maxLength": 32, "readOnly": true}, "customer_id": {"type": "string", "description": "The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\nAccess to this field requires seller-level permissions.", "maxLength": 192, "readOnly": true}}}, "source": {"type": "string", "enum": ["FIRST_PARTY_MERCHANT", "FIRST_PARTY_BUYER", "THIRD_PARTY_BUYER", "API"], "x-enum-elements": [{"name": "FIRST_PARTY_MERCHANT", "description": "The booking was created by a seller from a Square Appointments application, such as the Square Appointments Dashboard or a Square Appointments mobile app."}, {"name": "FIRST_PARTY_BUYER", "description": "The booking was created by a buyer from a Square Appointments application, such as Square Online Booking Site."}, {"name": "THIRD_PARTY_BUYER", "description": "The booking was created by a buyer created from a third-party application."}, {"name": "API", "description": "The booking was created by a seller or a buyer from the Square Bookings API."}], "description": "Supported sources a booking was created from.", "x-release-status": "PUBLIC"}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}}}',  # noqa: E501
    "SEARCHBOOKINGAVAILABILITY": '{"type": "object", "x-release-status": "PUBLIC", "required": ["query"], "properties": {"query": {"type": "object", "description": "The query used to search for buyer-accessible availabilities of bookings.", "x-release-status": "PUBLIC", "required": ["filter"], "properties": {"filter": {"type": "object", "description": "A query filter to search for buyer-accessible availabilities by.", "x-release-status": "PUBLIC", "required": ["start_at_range"], "properties": {"start_at_range": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "location_id": {"type": "string", "description": "The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID.\nThis query expression cannot be set if `booking_id` is set.", "maxLength": 32, "nullable": true}, "segment_filters": {"type": "array", "items": {"type": "object", "description": "A query filter to search for buyer-accessible appointment segments by.", "x-release-status": "PUBLIC", "required": ["service_variation_id"], "properties": {"service_variation_id": {"type": "string", "description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.", "minLength": 1, "maxLength": 36}, "team_member_id_filter": {"type": "object", "description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field.", "x-release-status": "BETA", "properties": {"all": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must be present on the field of the resource.", "nullable": true}, "any": {"type": "array", "items": {"type": "string"}, "description": "A list of terms where at least one of them must be present on the\nfield of the resource.", "nullable": true}, "none": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must not be present on the field the resource", "nullable": true}}}}}, "description": "The query expression to search for buyer-accessible availabilities matching the specified list of segment filters.\nIf the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability.\n\nThis query expression cannot be set if `booking_id` is set.", "nullable": true}, "booking_id": {"type": "string", "description": "The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value.\nThis is commonly used to reschedule an appointment.\nIf this expression is set, the `location_id` and `segment_filters` expressions cannot be set.", "maxLength": 36, "nullable": true}}}}}}}',  # noqa: E501
    "BULKDELETEBOOKINGCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) request.", "x-release-status": "PUBLIC", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes)\nrequest. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.", "x-release-status": "PUBLIC", "required": ["booking_id", "key"], "properties": {"booking_id": {"type": "string", "description": "The ID of the target [booking](entity:Booking).", "minLength": 1, "maxLength": 36}, "key": {"type": "string", "description": "The key of the custom attribute to delete. This key must match the `key` of a\ncustom attribute definition in the Square seller account. If the requesting application is not\nthe definition owner, you must use the qualified key.", "minLength": 1}}}, "description": "A map containing 1 to 25 individual Delete requests. For each request, provide an\narbitrary ID that is unique for this `BulkDeleteBookingCustomAttributes` request and the\ninformation needed to delete a custom attribute."}}}',  # noqa: E501
    "BULKUPSERTBOOKINGCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) request.", "x-release-status": "PUBLIC", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes)\nrequest. An individual request contains a booking ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC", "required": ["booking_id", "custom_attribute"], "properties": {"booking_id": {"type": "string", "description": "The ID of the target [booking](entity:Booking).", "minLength": 1, "maxLength": 36}, "custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}}, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertBookingCustomAttributes` request and the\ninformation needed to create or update a custom attribute."}}}',  # noqa: E501
    "UPDATEBOOKING": '{"type": "object", "x-release-status": "PUBLIC", "required": ["booking"], "properties": {"idempotency_key": {"type": "string", "description": "A unique key to make this request an idempotent operation.", "maxLength": 255, "nullable": true}, "booking": {"type": "object", "description": "Represents a booking as a time-bound service contract for a seller\'s staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique ID of this object representing a booking.", "maxLength": 36, "readOnly": true}, "version": {"type": "integer", "description": "The revision number for the booking used for optimistic concurrency."}, "status": {"type": "string", "enum": ["PENDING", "CANCELLED_BY_CUSTOMER", "CANCELLED_BY_SELLER", "DECLINED", "ACCEPTED", "NO_SHOW"], "x-enum-elements": [{"name": "PENDING", "description": "An unaccepted booking. It is visible to both sellers and customers."}, {"name": "CANCELLED_BY_CUSTOMER", "description": "A customer-cancelled booking. It is visible to both the seller and the customer."}, {"name": "CANCELLED_BY_SELLER", "description": "A seller-cancelled booking. It is visible to both the seller and the customer."}, {"name": "DECLINED", "description": "A declined booking. It had once been pending, but was then declined by the seller."}, {"name": "ACCEPTED", "description": "An accepted booking agreed to or accepted by the seller."}, {"name": "NO_SHOW", "description": "A no-show booking. The booking was accepted at one time, but have now been marked as a no-show by\nthe seller because the client either missed the booking or cancelled it without enough notice."}], "description": "Supported booking statuses.", "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the creation time of this booking.", "readOnly": true}, "updated_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the most recent update time of this booking.", "readOnly": true}, "start_at": {"type": "string", "description": "The RFC 3339 timestamp specifying the starting time of this booking.", "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.", "maxLength": 32, "nullable": true}, "customer_id": {"type": "string", "description": "The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.", "maxLength": 192, "nullable": true}, "customer_note": {"type": "string", "description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.", "maxLength": 4096, "nullable": true}, "seller_note": {"type": "string", "description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\nThis field should not be visible to customers.", "maxLength": 4096, "nullable": true}, "appointment_segments": {"type": "array", "items": {"type": "object", "description": "Defines an appointment segment of a booking.", "x-release-status": "PUBLIC", "required": ["team_member_id"], "properties": {"duration_minutes": {"type": "integer", "description": "The time span in minutes of an appointment segment.", "maximum": 1500, "nullable": true}, "service_variation_id": {"type": "string", "description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.", "maxLength": 36, "nullable": true}, "team_member_id": {"type": "string", "description": "The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment.", "minLength": 1, "maxLength": 32}, "service_variation_version": {"type": "integer", "description": "The current version of the item variation representing the service booked in this segment.", "format": "int64", "nullable": true}, "intermission_minutes": {"type": "integer", "description": "Time between the end of this segment and the beginning of the subsequent segment.", "readOnly": true}, "any_team_member": {"type": "boolean", "description": "Whether the customer accepts any team member, instead of a specific one, to serve this segment.", "readOnly": true}, "resource_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the seller-accessible resources used for this appointment segment.", "readOnly": true}}}, "description": "A list of appointment segments for this booking.", "nullable": true}, "transition_time_minutes": {"type": "integer", "description": "Additional time at the end of a booking.\nApplications should not make this field visible to customers of a seller.", "readOnly": true}, "all_day": {"type": "boolean", "description": "Whether the booking is of a full business day.", "readOnly": true}, "location_type": {"type": "string", "enum": ["BUSINESS_LOCATION", "CUSTOMER_LOCATION", "PHONE"], "x-enum-elements": [{"name": "BUSINESS_LOCATION", "description": "The service is provided at a seller location."}, {"name": "CUSTOMER_LOCATION", "description": "The service is provided at a customer location."}, {"name": "PHONE", "description": "The service is provided over the phone."}], "description": "Supported types of location where service is provided.", "x-release-status": "PUBLIC"}, "creator_details": {"type": "object", "description": "Information about a booking creator.", "x-release-status": "PUBLIC", "properties": {"creator_type": {"type": "string", "enum": ["TEAM_MEMBER", "CUSTOMER"], "x-enum-elements": [{"name": "TEAM_MEMBER", "description": "The creator is of the seller type."}, {"name": "CUSTOMER", "description": "The creator is of the buyer type."}], "description": "Supported types of a booking creator.", "x-release-status": "PUBLIC"}, "team_member_id": {"type": "string", "description": "The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\nAccess to this field requires seller-level permissions.", "maxLength": 32, "readOnly": true}, "customer_id": {"type": "string", "description": "The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\nAccess to this field requires seller-level permissions.", "maxLength": 192, "readOnly": true}}}, "source": {"type": "string", "enum": ["FIRST_PARTY_MERCHANT", "FIRST_PARTY_BUYER", "THIRD_PARTY_BUYER", "API"], "x-enum-elements": [{"name": "FIRST_PARTY_MERCHANT", "description": "The booking was created by a seller from a Square Appointments application, such as the Square Appointments Dashboard or a Square Appointments mobile app."}, {"name": "FIRST_PARTY_BUYER", "description": "The booking was created by a buyer from a Square Appointments application, such as Square Online Booking Site."}, {"name": "THIRD_PARTY_BUYER", "description": "The booking was created by a buyer created from a third-party application."}, {"name": "API", "description": "The booking was created by a seller or a buyer from the Square Bookings API."}], "description": "Supported sources a booking was created from.", "x-release-status": "PUBLIC"}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}}}',  # noqa: E501
    "SETBOOKINGCUSTOMATTRIBUTE": '{"type": "object", "description": "Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) request.", "x-release-status": "PUBLIC", "required": ["custom_attribute"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}}',  # noqa: E501
    "ADDCARDTOMERCHANT": '{"type": "object", "description": "Creates a card from the source (payment token or payment id). Accessible via\nHTTP requests at POST https://connect.squareup.com/v2/cards", "x-release-status": "PUBLIC", "required": ["idempotency_key", "source_id", "card"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this CreateCard request. Keys can be\nany valid string and must be unique for every request.\n\nMax: 45 characters\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1}, "source_id": {"type": "string", "description": "The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.", "minLength": 1, "maxLength": 16384}, "verification_token": {"type": "string", "description": "An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).\nVerification tokens encapsulate customer device information and 3-D Secure\nchallenge results to indicate that Square has verified the buyer identity.\n\nSee the [SCA Overview](https://developer.squareup.com/docs/sca-overview)."}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}}, "example": {"card": {"billing_address": {"address_line_1": "500 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "cardholder_name": "Amelia Earhart", "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8", "reference_id": "user-id-1"}, "idempotency_key": "4935a656-a929-4792-b97c-8848be85c27c", "source_id": "cnon:uIbfJXhXETSP197M3GB"}}',  # noqa: E501
    "BATCHUPSERTCATALOGOBJECTS": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key", "batches"], "properties": {"idempotency_key": {"type": "string", "description": "A value you specify that uniquely identifies this\nrequest among all your requests. A common way to create\na valid idempotency key is to use a Universally unique\nidentifier (UUID).\n\nIf you\'re unsure whether a particular request was successful,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate objects.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1, "maxLength": 128}, "batches": {"type": "array", "items": {"type": "object", "description": "A batch of catalog objects.", "x-release-status": "PUBLIC", "required": ["objects"], "properties": {"objects": {"type": "array", "items": {"type": "object", "description": "The wrapper object for the catalog entries of a given object type.\n\nDepending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.\n\nFor example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.\n\nIn general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance.\n\nFor a more detailed discussion of the Catalog data model, please see the\n[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.", "x-release-status": "PUBLIC", "required": ["type", "id"], "properties": {"type": {"type": "string", "enum": ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER", "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD", "MEASUREMENT_UNIT", "SUBSCRIPTION_PLAN_VARIATION", "ITEM_OPTION", "ITEM_OPTION_VAL", "CUSTOM_ATTRIBUTE_DEFINITION", "QUICK_AMOUNTS_SETTINGS", "SUBSCRIPTION_PLAN", "AVAILABILITY_PERIOD"], "x-enum-elements": [{"name": "ITEM", "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field."}, {"name": "IMAGE", "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field."}, {"name": "CATEGORY", "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field."}, {"name": "ITEM_VARIATION", "description": "The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field."}, {"name": "TAX", "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field."}, {"name": "DISCOUNT", "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field."}, {"name": "MODIFIER_LIST", "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field."}, {"name": "MODIFIER", "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field."}, {"name": "PRICING_RULE", "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field."}, {"name": "PRODUCT_SET", "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field."}, {"name": "TIME_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field."}, {"name": "MEASUREMENT_UNIT", "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field."}, {"name": "SUBSCRIPTION_PLAN_VARIATION", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field."}, {"name": "ITEM_OPTION", "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field."}, {"name": "ITEM_OPTION_VAL", "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of "Size" may have item option values such as "Small" or "Medium".\nThe item-option-value-specific data must be on the `item_option_value_data` field."}, {"name": "CUSTOM_ATTRIBUTE_DEFINITION", "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field."}, {"name": "QUICK_AMOUNTS_SETTINGS", "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field."}, {"name": "SUBSCRIPTION_PLAN", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field."}, {"name": "AVAILABILITY_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field."}], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", "x-release-status": "PUBLIC"}, "id": {"type": "string", "description": "An identifier to reference this object in the catalog. When a new `CatalogObject`\nis inserted, the client should set the id to a temporary identifier starting with\na "`#`" character. Other objects being inserted or updated within the same request\nmay use this identifier to refer to the new object.\n\nWhen the server receives the new object, it will supply a unique identifier that\nreplaces the temporary identifier for all future references.", "minLength": 1}, "updated_at": {"type": "string", "description": "Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"`\nwould indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.", "readOnly": true}, "version": {"type": "integer", "description": "The version of the object. When updating an object, the version supplied\nmust match the version in the database, otherwise the write will be rejected as conflicting.", "format": "int64"}, "is_deleted": {"type": "boolean", "description": "If `true`, the object has been deleted from the database. Must be `false` for new objects\nbeing inserted. When deleted, the `updated_at` field will equal the deletion time.", "nullable": true}, "custom_attribute_values": {"type": "object", "additionalProperties": {"type": "object", "description": "An instance of a custom attribute. Custom attributes can be defined and\nadded to `ITEM` and `ITEM_VARIATION` type catalog objects.\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes).", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name of the custom attribute.", "nullable": true}, "string_value": {"type": "string", "description": "The string value of the custom attribute.  Populated if `type` = `STRING`.", "nullable": true}, "custom_attribute_definition_id": {"type": "string", "description": "The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to.", "readOnly": true}, "type": {"type": "string", "enum": ["STRING", "BOOLEAN", "NUMBER", "SELECTION"], "x-enum-elements": [{"name": "STRING", "description": "A free-form string containing up to 255 characters."}, {"name": "BOOLEAN", "description": "A `true` or `false` value."}, {"name": "NUMBER", "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point."}, {"name": "SELECTION", "description": "One or more choices from `allowed_selections`."}], "description": "Defines the possible types for a custom attribute.", "x-release-status": "PUBLIC"}, "number_value": {"type": "string", "description": "Populated if `type` = `NUMBER`. Contains a string\nrepresentation of a decimal number, using a `.` as the decimal separator.", "nullable": true}, "boolean_value": {"type": "boolean", "description": "A `true` or `false` value. Populated if `type` = `BOOLEAN`.", "nullable": true}, "selection_uid_values": {"type": "array", "items": {"type": "string"}, "description": "One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.", "nullable": true}, "key": {"type": "string", "description": "If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID.\nFor example, if the CatalogCustomAttributeDefinition has a key attribute of "cocoa_brand" and the defining application ID is "abcd1234", this key is "abcd1234:cocoa_brand"\nwhen the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand".", "readOnly": true}}}, "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\'s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `"cocoa_brand"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).", "nullable": true}, "catalog_v1_ids": {"type": "array", "items": {"type": "object", "description": "A Square API V1 identifier of an item, including the object ID and its associated location ID.", "x-release-status": "PUBLIC", "properties": {"catalog_v1_id": {"type": "string", "description": "The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID.", "nullable": true}, "location_id": {"type": "string", "description": "The ID of the `Location` this Connect V1 ID is associated with.", "nullable": true}}}, "description": "The Connect v1 IDs for this object at each location where it is present, where they\ndiffer from the object\'s Connect V2 ID. The field will only be present for objects that\nhave been created or modified by legacy APIs.", "nullable": true}, "present_at_all_locations": {"type": "boolean", "description": "If `true`, this object is present at all locations (including future locations), except where specified in\nthe `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations),\nexcept where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.", "nullable": true}, "present_at_location_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of locations where the object is present, even if `present_at_all_locations` is `false`.\nThis can include locations that are deactivated.", "nullable": true}, "absent_at_location_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of locations where the object is not present, even if `present_at_all_locations` is `true`.\nThis can include locations that are deactivated.", "nullable": true}, "item_data": {"type": "object", "description": "A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The item\'s name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.", "maxLength": 512, "nullable": true}, "description": {"type": "string", "description": "The item\'s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](entity:CatalogItem) instance.  The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", "maxLength": 4096, "x-release-status": "DEPRECATED", "nullable": true}, "abbreviation": {"type": "string", "description": "The text of the item\'s display label in the Square Point of Sale app. Only up to the first five characters of the string are used.\nThis attribute is searchable, and its value length is of Unicode code points.", "maxLength": 24, "nullable": true}, "label_color": {"type": "string", "description": "The color of the item\'s display label in the Square Point of Sale app. This must be a valid hex color code.", "nullable": true}, "is_taxable": {"type": "boolean", "description": "Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`.", "nullable": true}, "category_id": {"type": "string", "description": "The ID of the item\'s category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead.", "x-release-status": "DEPRECATED", "nullable": true}, "tax_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of IDs indicating the taxes enabled for\nthis item. When updating an item, any taxes listed here will be added to the item.\nTaxes may also be added to or deleted from an item using `UpdateItemTaxes`.", "nullable": true}, "modifier_list_info": {"type": "array", "items": {"type": "object", "description": "Controls how a modifier list is applied to a specific item. This object allows for item-specific customization of modifier list behavior\nand provides the ability to override global modifier list settings.", "x-release-status": "PUBLIC", "required": ["modifier_list_id"], "properties": {"modifier_list_id": {"type": "string", "description": "The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.", "minLength": 1}, "modifier_overrides": {"type": "array", "items": {"type": "object", "description": "Options to control how to override the default behavior of the specified modifier.", "x-release-status": "PUBLIC", "required": ["modifier_id"], "properties": {"modifier_id": {"type": "string", "description": "The ID of the `CatalogModifier` whose default behavior is being overridden.", "minLength": 1}, "on_by_default": {"type": "boolean", "description": "__Deprecated__: Use `on_by_default_override` instead.", "x-release-status": "DEPRECATED", "nullable": true}, "hidden_online_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "on_by_default_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}}}, "description": "A set of `CatalogModifierOverride` objects that override default modifier settings for this item.", "nullable": true}, "min_selected_modifiers": {"type": "integer", "description": "The minimum number of modifiers that must be selected from this modifier list.\nValues:\n\n- 0: No selection is required.\n- -1: Default value, the attribute was not set by the client. When `max_selected_modifiers` is\nalso -1, use the minimum and maximum selection values set on the `CatalogItemModifierList`.\n- &gt;0: The required minimum modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no selection required.", "nullable": true}, "max_selected_modifiers": {"type": "integer", "description": "The maximum number of modifiers that can be selected.\nValues:\n\n- 0: No maximum limit.\n- -1: Default value, the attribute was not set by the client. When `min_selected_modifiers` is\nalso -1, use the minimum and maximum selection values set on the `CatalogItemModifierList`.\n- &gt;0: The maximum total modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no maximum limit.", "nullable": true}, "enabled": {"type": "boolean", "description": "If `true`, enable this `CatalogModifierList`. The default value is `true`.", "nullable": true}, "ordinal": {"type": "integer", "description": "The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied \nto a `CatalogItem` instance.", "x-release-status": "BETA", "nullable": true}, "allow_quantities": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "is_conversational": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "hidden_from_customer_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}}}, "description": "A set of `CatalogItemModifierListInfo` objects\nrepresenting the modifier lists that apply to this item, along with the overrides and min\nand max limits that are specific to this item. Modifier lists\nmay also be added to or deleted from an item using `UpdateItemModifierLists`.", "nullable": true}, "variations": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have\nat least one variation.", "nullable": true}, "product_type": {"type": "string", "enum": ["REGULAR", "GIFT_CARD", "APPOINTMENTS_SERVICE", "FOOD_AND_BEV", "EVENT", "DIGITAL", "DONATION", "LEGACY_SQUARE_ONLINE_SERVICE", "LEGACY_SQUARE_ONLINE_MEMBERSHIP"], "x-enum-elements": [{"name": "REGULAR", "description": "An ordinary item."}, {"name": "GIFT_CARD", "description": "A Square gift card."}, {"name": "APPOINTMENTS_SERVICE", "description": "A service that can be booked using the Square Appointments app."}, {"name": "FOOD_AND_BEV", "description": "A food or beverage item that can be sold by restaurants and other food venues."}, {"name": "EVENT", "description": "An event which tickets can be sold for, including location, address, and times."}, {"name": "DIGITAL", "description": "A digital item like an ebook or song."}, {"name": "DONATION", "description": "A donation which site visitors can send for any cause."}, {"name": "LEGACY_SQUARE_ONLINE_SERVICE", "description": "A legacy Square Online service that is manually fulfilled. This corresponds to the `Other` item type displayed in the Square Seller Dashboard and Square POS apps."}, {"name": "LEGACY_SQUARE_ONLINE_MEMBERSHIP", "description": "A legacy Square Online membership that is manually fulfilled. This corresponds to the `Membership` item type displayed in the Square Seller Dashboard and Square POS apps."}], "description": "The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.", "x-release-status": "PUBLIC"}, "skip_modifier_screen": {"type": "boolean", "description": "If `false`, the Square Point of Sale app will present the `CatalogItem`\'s\ndetails screen immediately, allowing the merchant to choose `CatalogModifier`s\nbefore adding the item to the cart.  This is the default behavior.\n\nIf `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected\nmodifiers, and merchants can edit modifiers by drilling down onto the item\'s details.\n\nThird-party clients are encouraged to implement similar behaviors.", "nullable": true}, "item_options": {"type": "array", "items": {"type": "object", "description": " An option that can be assigned to an item.\nFor example, a t-shirt item may offer a color option or a size option.", "x-release-status": "BETA", "properties": {"item_option_id": {"type": "string", "description": "The unique id of the item option, used to form the dimensions of the item option matrix in a specified order.", "nullable": true}}}, "description": "List of item options IDs for this item. Used to manage and group item\nvariations in a specified order.\n\nMaximum: 6 item options.", "nullable": true}, "ecom_uri": {"type": "string", "description": "Deprecated. A URI pointing to a published e-commerce product page for the Item.", "x-release-status": "DEPRECATED", "nullable": true}, "ecom_image_uris": {"type": "array", "items": {"type": "string"}, "description": "Deprecated. A comma-separated list of encoded URIs pointing to a set of published e-commerce images for the Item.", "x-release-status": "DEPRECATED", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogItem` instance.\nThese images will be shown to customers in Square Online Store.\nThe first image will show up as the icon for this item in POS.", "x-release-status": "BETA", "nullable": true}, "sort_name": {"type": "string", "description": "A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting.\nIts value must not be empty.\n\nIt is currently supported for sellers of the Japanese locale only.", "x-release-status": "BETA", "nullable": true}, "categories": {"type": "array", "items": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "description": "The list of categories.", "nullable": true}, "description_html": {"type": "string", "description": "The item\'s description as expressed in valid HTML elements. The length of this field value, including those of HTML tags,\nis of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or\nunsupported HTML elements or attributes are ignored.\n\nSupported HTML elements include:\n- `a`: Link. Supports linking to website URLs, email address, and telephone numbers.\n- `b`, `strong`:  Bold text\n- `br`: Line break\n- `code`: Computer code\n- `div`: Section\n- `h1-h6`: Headings\n- `i`, `em`: Italics\n- `li`: List element\n- `ol`: Numbered list\n- `p`: Paragraph\n- `ul`: Bullet list\n- `u`: Underline\n\n\nSupported HTML attributes include:\n- `align`: Alignment of the text content\n- `href`: Link destination\n- `rel`: Relationship between link\'s target and source\n- `target`: Place to open the linked document", "maxLength": 65535, "nullable": true}, "description_plaintext": {"type": "string", "description": "A server-generated plaintext version of the `description_html` field, without formatting tags.", "maxLength": 65535, "readOnly": true}, "channels": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.\nThis field is read only and cannot be edited.", "nullable": true}, "is_archived": {"type": "boolean", "description": "Indicates whether this item is archived (`true`) or not (`false`).", "nullable": true}, "ecom_seo_data": {"type": "object", "description": "SEO data for for a seller\'s Square Online store.", "x-release-status": "PUBLIC", "properties": {"page_title": {"type": "string", "description": "The SEO title used for the Square Online store.", "nullable": true}, "page_description": {"type": "string", "description": "The SEO description used for the Square Online store.", "nullable": true}, "permalink": {"type": "string", "description": "The SEO permalink used for the Square Online store.", "nullable": true}}}, "food_and_beverage_details": {"type": "object", "description": "The food and beverage-specific details of a `FOOD_AND_BEV` item.", "x-release-status": "PUBLIC", "properties": {"calorie_count": {"type": "integer", "description": "The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items.", "nullable": true}, "dietary_preferences": {"type": "array", "items": {"type": "object", "description": "Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STANDARD", "CUSTOM"], "x-enum-elements": [{"name": "STANDARD", "description": "A standard value from a pre-determined list."}, {"name": "CUSTOM", "description": "A user-defined custom value."}], "description": "The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.", "x-release-status": "PUBLIC"}, "standard_name": {"type": "string", "enum": ["DAIRY_FREE", "GLUTEN_FREE", "HALAL", "KOSHER", "NUT_FREE", "VEGAN", "VEGETARIAN"], "x-enum-elements": [{"name": "DAIRY_FREE", "description": ""}, {"name": "GLUTEN_FREE", "description": ""}, {"name": "HALAL", "description": ""}, {"name": "KOSHER", "description": ""}, {"name": "NUT_FREE", "description": ""}, {"name": "VEGAN", "description": ""}, {"name": "VEGETARIAN", "description": ""}], "description": "Standard dietary preferences for food and beverage items that are recommended on item creation.", "x-release-status": "PUBLIC"}, "custom_name": {"type": "string", "description": "The name of a user-defined custom dietary preference. This should be null if it\'s a standard dietary preference.", "nullable": true}}}, "description": "The dietary preferences for the `FOOD_AND_BEV` item.", "nullable": true}, "ingredients": {"type": "array", "items": {"type": "object", "description": "Describes the ingredient used in a `FOOD_AND_BEV` item.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STANDARD", "CUSTOM"], "x-enum-elements": [{"name": "STANDARD", "description": "A standard value from a pre-determined list."}, {"name": "CUSTOM", "description": "A user-defined custom value."}], "description": "The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.", "x-release-status": "PUBLIC"}, "standard_name": {"type": "string", "enum": ["CELERY", "CRUSTACEANS", "EGGS", "FISH", "GLUTEN", "LUPIN", "MILK", "MOLLUSCS", "MUSTARD", "PEANUTS", "SESAME", "SOY", "SULPHITES", "TREE_NUTS"], "x-enum-elements": [{"name": "CELERY", "description": ""}, {"name": "CRUSTACEANS", "description": ""}, {"name": "EGGS", "description": ""}, {"name": "FISH", "description": ""}, {"name": "GLUTEN", "description": ""}, {"name": "LUPIN", "description": ""}, {"name": "MILK", "description": ""}, {"name": "MOLLUSCS", "description": ""}, {"name": "MUSTARD", "description": ""}, {"name": "PEANUTS", "description": ""}, {"name": "SESAME", "description": ""}, {"name": "SOY", "description": ""}, {"name": "SULPHITES", "description": ""}, {"name": "TREE_NUTS", "description": ""}], "description": "Standard ingredients for food and beverage items that are recommended on item creation.", "x-release-status": "PUBLIC"}, "custom_name": {"type": "string", "description": "The name of a custom user-defined ingredient. This should be null if it\'s a standard dietary preference.", "nullable": true}}}, "description": "The ingredients for the `FOOD_AND_BEV` type item.", "nullable": true}}}, "reporting_category": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "is_alcoholic": {"type": "boolean", "description": "Indicates whether this item is alcoholic (`true`) or not (`false`).", "nullable": true}}, "example": {"object": {"id": "#Cocoa", "item_data": {"abbreviation": "Ch", "description": "Hot chocolate", "name": "Cocoa", "visibility": "PRIVATE"}, "present_at_all_locations": true, "type": "ITEM"}}}, "category_data": {"type": "object", "description": "A category to which a `CatalogItem` instance belongs.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogCategory` instance.\nCurrently these images are not displayed by Square, but are free to be displayed in 3rd party applications.", "nullable": true}, "category_type": {"type": "string", "enum": ["REGULAR_CATEGORY", "MENU_CATEGORY", "KITCHEN_CATEGORY"], "x-enum-elements": [{"name": "REGULAR_CATEGORY", "description": "The regular category."}, {"name": "MENU_CATEGORY", "description": "The menu category."}, {"name": "KITCHEN_CATEGORY", "description": "Kitchen categories are used by KDS (Kitchen Display System) to route items to specific clients"}], "description": "Indicates the type of a category.", "x-release-status": "PUBLIC"}, "parent_category": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "is_top_level": {"type": "boolean", "description": "Indicates whether a category is a top level category, which does not have any parent_category.", "nullable": true}, "channels": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs representing channels, such as a Square Online site, where the category can be made visible.", "nullable": true}, "availability_period_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.", "nullable": true}, "online_visibility": {"type": "boolean", "description": "Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller\'s Square Online sites.", "nullable": true}, "root_category": {"type": "string", "description": "The top-level category in a category hierarchy.", "readOnly": true}, "ecom_seo_data": {"type": "object", "description": "SEO data for for a seller\'s Square Online store.", "x-release-status": "PUBLIC", "properties": {"page_title": {"type": "string", "description": "The SEO title used for the Square Online store.", "nullable": true}, "page_description": {"type": "string", "description": "The SEO description used for the Square Online store.", "nullable": true}, "permalink": {"type": "string", "description": "The SEO permalink used for the Square Online store.", "nullable": true}}}, "path_to_root": {"type": "array", "items": {"type": "object", "description": "A node in the path from a retrieved category to its root node.", "x-release-status": "PUBLIC", "properties": {"category_id": {"type": "string", "description": "The category\'s ID.", "nullable": true}, "category_name": {"type": "string", "description": "The category\'s name.", "nullable": true}}}, "description": "The path from the category to its root category. The first node of the path is the parent of the category\nand the last is the root category. The path is empty if the category is a root category.", "nullable": true}}, "example": {"object": {"category_data": {"name": "Beverages"}, "id": "#Beverages", "present_at_all_locations": true, "type": "CATEGORY"}}}, "item_variation_data": {"type": "object", "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\'s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", "x-release-status": "PUBLIC", "properties": {"item_id": {"type": "string", "description": "The ID of the `CatalogItem` associated with this item variation.", "nullable": true}, "name": {"type": "string", "description": "The item variation\'s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem)\nuses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points.", "nullable": true}, "sku": {"type": "string", "description": "The item variation\'s SKU, if any. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "upc": {"type": "string", "description": "The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters.\n\nThe value of this attribute should be a number of 12-14 digits long.  This restriction is enforced on the Square Seller Dashboard,\nSquare Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned\nto this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps\nunless it is updated to fit the expected format.", "nullable": true}, "ordinal": {"type": "integer", "description": "The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal\nfor each item variation within a parent `CatalogItem` is set according to the item variations\'s\nposition. On reads, the value is not guaranteed to be sequential or unique.", "readOnly": true}, "pricing_type": {"type": "string", "enum": ["FIXED_PRICING", "VARIABLE_PRICING"], "x-enum-elements": [{"name": "FIXED_PRICING", "description": "The catalog item variation\'s price is fixed."}, {"name": "VARIABLE_PRICING", "description": "The catalog item variation\'s price is entered at the time of sale."}], "description": "Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.", "x-release-status": "PUBLIC"}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "location_overrides": {"type": "array", "items": {"type": "object", "description": "Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.", "x-release-status": "PUBLIC", "properties": {"location_id": {"type": "string", "description": "The ID of the `Location`. This can include locations that are deactivated.", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_type": {"type": "string", "enum": ["FIXED_PRICING", "VARIABLE_PRICING"], "x-enum-elements": [{"name": "FIXED_PRICING", "description": "The catalog item variation\'s price is fixed."}, {"name": "VARIABLE_PRICING", "description": "The catalog item variation\'s price is entered at the time of sale."}], "description": "Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.", "x-release-status": "PUBLIC"}, "track_inventory": {"type": "boolean", "description": "If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.", "nullable": true}, "inventory_alert_type": {"type": "string", "enum": ["NONE", "LOW_QUANTITY"], "x-enum-elements": [{"name": "NONE", "description": "The variation does not display an alert."}, {"name": "LOW_QUANTITY", "description": "The variation generates an alert when its quantity is low."}], "description": "Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.", "x-release-status": "PUBLIC"}, "inventory_alert_threshold": {"type": "integer", "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", "format": "int64", "nullable": true}, "sold_out": {"type": "boolean", "description": "Indicates whether the overridden item variation is sold out at the specified location.\n\nWhen inventory tracking is enabled on the item variation either globally or at the specified location,\nthe item variation is automatically marked as sold out when its inventory count reaches zero. The seller\ncan manually set the item variation as sold out even when the inventory count is greater than zero.\nAttempts by an application to set this attribute are ignored. Regardless how the sold-out status is set,\napplications should treat its inventory count as zero when this attribute value is `true`.", "readOnly": true}, "sold_out_valid_until": {"type": "string", "description": "The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation\nbecomes available again at the specified location. Attempts by an application to set this attribute are ignored.\nWhen the current time is later than this attribute value, the affected item variation is no longer sold out.", "readOnly": true}}}, "description": "Per-location price and inventory overrides.", "nullable": true}, "track_inventory": {"type": "boolean", "description": "If `true`, inventory tracking is active for the variation.", "nullable": true}, "inventory_alert_type": {"type": "string", "enum": ["NONE", "LOW_QUANTITY"], "x-enum-elements": [{"name": "NONE", "description": "The variation does not display an alert."}, {"name": "LOW_QUANTITY", "description": "The variation generates an alert when its quantity is low."}], "description": "Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.", "x-release-status": "PUBLIC"}, "inventory_alert_threshold": {"type": "integer", "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", "format": "int64", "nullable": true}, "user_data": {"type": "string", "description": "Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "service_duration": {"type": "integer", "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For\nexample, a 30 minute appointment would have the value `1800000`, which is equal to\n30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).", "format": "int64", "nullable": true}, "available_for_booking": {"type": "boolean", "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.", "x-release-status": "BETA", "nullable": true}, "item_option_values": {"type": "array", "items": {"type": "object", "description": "A `CatalogItemOptionValue` links an item variation to an item option as\nan item option value. For example, a t-shirt item may offer a color option and\na size option. An item option value would represent each variation of t-shirt:\nFor example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium".", "x-release-status": "PUBLIC", "properties": {"item_option_id": {"type": "string", "description": "The unique id of an item option.", "nullable": true}, "item_option_value_id": {"type": "string", "description": "The unique id of the selected value for the item option.", "nullable": true}}}, "description": "List of item option values associated with this item variation. Listed\nin the same order as the item options of the parent item.", "nullable": true}, "measurement_unit_id": {"type": "string", "description": "ID of the \u2018CatalogMeasurementUnit\u2019 that is used to measure the quantity\nsold of this item variation. If left unset, the item will be sold in\nwhole quantities.", "nullable": true}, "sellable": {"type": "boolean", "description": "Whether this variation can be sold. The inventory count of a sellable variation indicates\nthe number of units available for sale. When a variation is both stockable and sellable,\nits sellable inventory count can be smaller than or equal to its stockable count.", "x-release-status": "BETA", "nullable": true}, "stockable": {"type": "boolean", "description": "Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE).\nWhen a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock\nand is not an indicator of the number of units of the variation that can be sold.", "x-release-status": "BETA", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogItemVariation` instance.\nThese images will be shown to customers in Square Online Store.", "nullable": true}, "team_member_ids": {"type": "array", "items": {"type": "string"}, "description": "Tokens of employees that can perform the service represented by this variation. Only valid for\nvariations of type `APPOINTMENTS_SERVICE`.", "x-release-status": "BETA", "nullable": true}, "stockable_conversion": {"type": "object", "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](entity:CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", "x-release-status": "BETA", "required": ["stockable_item_variation_id", "stockable_quantity", "nonstockable_quantity"], "properties": {"stockable_item_variation_id": {"type": "string", "description": "References to the stockable [CatalogItemVariation](entity:CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.`", "minLength": 1}, "stockable_quantity": {"type": "string", "description": "The quantity of the stockable item variation (as identified by `stockable_item_variation_id`)\nequivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`)\nas defined by this stock conversion.  It accepts a decimal number in a string format that can take\nup to 10 digits before the decimal point and up to 5 digits after the decimal point.", "minLength": 1, "maxLength": 16}, "nonstockable_quantity": {"type": "string", "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point.", "minLength": 1, "maxLength": 16}}}}}, "tax_data": {"type": "object", "description": "A tax applicable to an item.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The tax\'s name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "calculation_phase": {"type": "string", "enum": ["TAX_SUBTOTAL_PHASE", "TAX_TOTAL_PHASE"], "x-enum-elements": [{"name": "TAX_SUBTOTAL_PHASE", "description": "The fee is calculated based on the payment\'s subtotal."}, {"name": "TAX_TOTAL_PHASE", "description": "The fee is calculated based on the payment\'s total."}], "description": "When to calculate the taxes due on a cart.", "x-release-status": "PUBLIC"}, "inclusion_type": {"type": "string", "enum": ["ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the\nCatalogItemVariation price. For example, a $1.00 item with a 10% additive\ntax would have a total cost to the buyer of $1.10."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. The tax amount is included in the\nCatalogItemVariation price. For example, a $1.00 item with a 10% inclusive\ntax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of\nthat total being the cost of the item and $0.09 (9 cents) being tax."}], "description": "Whether to the tax amount should be additional to or included in the CatalogItem price.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax in decimal form, using a `\'.\'` as the decimal separator and without a `\'%\'` sign.\nA value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.", "nullable": true}, "applies_to_custom_amounts": {"type": "boolean", "description": "If `true`, the fee applies to custom amounts entered into the Square Point of Sale\napp that are not associated with a particular `CatalogItem`.", "nullable": true}, "enabled": {"type": "boolean", "description": "A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).", "nullable": true}, "applies_to_product_set_id": {"type": "string", "description": "The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.", "x-release-status": "BETA", "nullable": true}}, "example": {"object": {"id": "#SalesTax", "present_at_all_locations": true, "tax_data": {"calculation_phase": "TAX_SUBTOTAL_PHASE", "enabled": true, "fee_applies_to_custom_amounts": true, "inclusion_type": "ADDITIVE", "name": "Sales Tax", "percentage": "5.0"}, "type": "TAX"}}}, "discount_data": {"type": "object", "description": "A discount applicable to items.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "discount_type": {"type": "string", "enum": ["FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (e.g., 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed amount (e.g., $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage off the item price. The percentage will be specified at the time of sale."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount off the item price. The amount will be specified at the time of sale."}], "description": "How to apply a CatalogDiscount to a CatalogItem.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal\nseparator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type`\nis `VARIABLE_PERCENTAGE`.\n\nDo not use this field for amount-based or variable discounts.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pin_required": {"type": "boolean", "description": "Indicates whether a mobile staff member needs to enter their PIN to apply the\ndiscount to a payment in the Square Point of Sale app.", "nullable": true}, "label_color": {"type": "string", "description": "The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.", "nullable": true}, "modify_tax_basis": {"type": "string", "enum": ["MODIFY_TAX_BASIS", "DO_NOT_MODIFY_TAX_BASIS"], "x-enum-elements": [{"name": "MODIFY_TAX_BASIS", "description": "Application of the discount will modify the tax basis."}, {"name": "DO_NOT_MODIFY_TAX_BASIS", "description": "Application of the discount will not modify the tax basis."}], "x-release-status": "PUBLIC"}, "maximum_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}, "example": {"object": {"discount_data": {"discount_type": "FIXED_PERCENTAGE", "label_color": "red", "name": "Welcome to the Dark(Roast) Side!", "percentage": "5.4", "pin_required": false}, "id": "#Maythe4th", "present_at_all_locations": true, "type": "DISCOUNT"}}}, "modifier_list_data": {"type": "object", "description": "A container for a list of modifiers, or a text-based modifier.\nFor text-based modifiers, this represents text configuration for an item. (For example, custom text to print on a t-shirt).\nFor non text-based modifiers, this represents a list of modifiers that can be applied to items at the time of sale.\n(For example, a list of condiments for a hot dog, or a list of ice cream flavors).\nEach element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of \nUnicode code points.", "maxLength": 255, "nullable": true}, "ordinal": {"type": "integer", "description": "The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances.", "nullable": true}, "selection_type": {"type": "string", "enum": ["SINGLE", "MULTIPLE"], "x-enum-elements": [{"name": "SINGLE", "description": "Indicates that a CatalogModifierList allows only a\nsingle CatalogModifier to be selected."}, {"name": "MULTIPLE", "description": "Indicates that a CatalogModifierList allows multiple\nCatalogModifier to be selected."}], "description": "Indicates whether a CatalogModifierList supports multiple selections.", "x-release-status": "PUBLIC"}, "modifiers": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`, \nfor non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list \nis a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes:\n```\n{\n"id": "{{catalog_modifier_id}}",\n"type": "MODIFIER", \n"modifier_data": {{a CatalogModifier instance>}} \n}\n```", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogModifierList` instance.\nCurrently these images are not displayed on Square products, but may be displayed in 3rd-party applications.", "nullable": true}, "allow_quantities": {"type": "boolean", "description": "When `true`, allows multiple quantities of the same modifier to be selected.", "x-release-status": "BETA", "nullable": true}, "is_conversational": {"type": "boolean", "description": "True if modifiers belonging to this list can be used conversationally.", "x-release-status": "BETA", "nullable": true}, "modifier_type": {"type": "string", "enum": ["LIST", "TEXT"], "x-enum-elements": [{"name": "LIST", "description": "The `CatalogModifierList` instance is a non-empty list of non text-based modifiers."}, {"name": "TEXT", "description": "The `CatalogModifierList` instance is a single text-based modifier."}], "description": "Defines the type of `CatalogModifierList`.", "x-release-status": "BETA"}, "max_length": {"type": "integer", "description": "The maximum length, in Unicode points, of the text string of the text-based modifier as represented by \nthis `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", "x-release-status": "BETA", "nullable": true}, "text_required": {"type": "boolean", "description": "Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier\nas represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", "x-release-status": "BETA", "nullable": true}, "internal_name": {"type": "string", "description": "A note for internal use by the business.   \n\nFor example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of "Hello, Kitty!"  \nis to be printed on the T-shirt, this `internal_name` attribute can be "Use italic face" as \nan instruction for the business to follow.  \n\nFor non text-based modifiers, this `internal_name` attribute can be \nused to include SKUs, internal codes, or supplemental descriptions for internal use.", "maxLength": 512, "x-release-status": "BETA", "nullable": true}, "min_selected_modifiers": {"type": "integer", "description": "The minimum number of modifiers that must be selected from this list. The value can be overridden with `CatalogItemModifierListInfo`.\n\nValues:\n\n- 0: No selection is required.\n- -1: Default value, the attribute was not set by the client. Treated as no selection required.\n- &gt;0: The required minimum modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no selection required.", "format": "int64", "x-release-status": "BETA", "nullable": true}, "max_selected_modifiers": {"type": "integer", "description": "The maximum number of modifiers that must be selected from this list. The value can be overridden with `CatalogItemModifierListInfo`.\n\nValues:\n\n- 0: No maximum limit.\n- -1: Default value, the attribute was not set by the client. Treated as no maximum limit.\n- &gt;0: The maximum total modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no maximum limit.", "format": "int64", "x-release-status": "BETA", "nullable": true}, "hidden_from_customer": {"type": "boolean", "description": "If `true`, modifiers from this list are hidden from customer receipts. The default value is `false`.\nThis setting can be overridden with `CatalogItemModifierListInfo.hidden_from_customer_override`.", "x-release-status": "BETA", "nullable": true}}, "example": {"id": "#MilkType", "modifier_list_data": {"allow_quantities": false, "modifiers": [{"modifier_data": {"name": "Whole Milk", "price_money": {"amount": 0, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}, {"modifier_data": {"name": "Almond Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}, {"modifier_data": {"name": "Soy Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}], "name": "Milk Type", "selection_type": "SINGLE"}, "present_at_all_locations": true, "type": "MODIFIER_LIST"}}, "modifier_data": {"type": "object", "description": "A modifier that can be applied to items at the time of sale. For example, a cheese modifier for a burger, or a flavor modifier for a serving of ice cream.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The modifier name.  This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "on_by_default": {"type": "boolean", "description": "When `true`, this modifier is selected by default when displaying the modifier list.\nThis setting can be overridden at the item level using `CatalogModifierListInfo.modifier_overrides`.", "x-release-status": "BETA", "nullable": true}, "ordinal": {"type": "integer", "description": "Determines where this `CatalogModifier` appears in the `CatalogModifierList`.", "nullable": true}, "modifier_list_id": {"type": "string", "description": "The ID of the `CatalogModifierList` associated with this modifier.", "nullable": true}, "location_overrides": {"type": "array", "items": {"type": "object", "description": "Location-specific overrides for specified properties of a `CatalogModifier` object.", "x-release-status": "PUBLIC", "properties": {"location_id": {"type": "string", "description": "The ID of the `Location` object representing the location. This can include a deactivated location.", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "sold_out": {"type": "boolean", "description": "Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out.\nThe seller can manually set this sold out status. Attempts by an application to set this attribute are ignored.", "readOnly": true}}}, "description": "Location-specific price overrides.", "nullable": true}, "image_id": {"type": "string", "description": "The ID of the image associated with this `CatalogModifier` instance.\nCurrently this image is not displayed by Square, but is free to be displayed in 3rd party applications.", "x-release-status": "BETA", "nullable": true}, "hidden_online": {"type": "boolean", "description": "When `true`, this modifier is hidden from online ordering channels. This setting can be overridden at the item level using `CatalogModifierListInfo.modifier_overrides`.", "x-release-status": "BETA", "nullable": true}}, "example": {"object": {"modifier_data": {"name": "Almond Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}}}, "time_period_data": {"type": "object", "description": "Represents a time period - either a single period or a repeating period.", "x-release-status": "PUBLIC", "properties": {"event": {"type": "string", "description": "An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which\nspecifies the name, timing, duration and recurrence of this time period.\n\nExample:\n\n```\nDTSTART:20190707T180000\nDURATION:P2H\nRRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR\n```\n\nOnly `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported.\n`DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT`\nand `END:VEVENT` is not required in the request. The response will always\ninclude them.", "nullable": true}}}, "product_set_data": {"type": "object", "description": "Represents a collection of catalog objects for the purpose of applying a\n`PricingRule`. Including a catalog object will include all of its subtypes.\nFor example, including a category in a product set will include all of its\nitems and associated item variations in the product set. Including an item in\na product set will also include its item variations.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "User-defined name for the product set. For example, "Clearance Items"\nor "Winter Sale Items".", "nullable": true}, "product_ids_any": {"type": "array", "items": {"type": "string"}, "description": " Unique IDs for any `CatalogObject` included in this product set. Any\nnumber of these catalog objects can be in an order for a pricing rule to apply.\n\nThis can be used with `product_ids_all` in a parent `CatalogProductSet` to\nmatch groups of products for a bulk discount, such as a discount for an\nentree and side combo.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", "nullable": true}, "product_ids_all": {"type": "array", "items": {"type": "string"}, "description": "Unique IDs for any `CatalogObject` included in this product set.\nAll objects in this set must be included in an order for a pricing rule to apply.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", "nullable": true}, "quantity_exact": {"type": "integer", "description": "If set, there must be exactly this many items from `products_any` or `products_all`\nin the cart for the discount to apply.\n\nCannot be combined with either `quantity_min` or `quantity_max`.", "format": "int64", "nullable": true}, "quantity_min": {"type": "integer", "description": "If set, there must be at least this many items from `products_any` or `products_all`\nin a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if\n`quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.", "format": "int64", "nullable": true}, "quantity_max": {"type": "integer", "description": "If set, the pricing rule will apply to a maximum of this many items from\n`products_any` or `products_all`.", "format": "int64", "nullable": true}, "all_products": {"type": "boolean", "description": "If set to `true`, the product set will include every item in the catalog.\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.", "nullable": true}}}, "pricing_rule_data": {"type": "object", "description": "Defines how discounts are automatically applied to a set of items that match the pricing rule\nduring the active time period.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "User-defined name for the pricing rule. For example, "Buy one get one\nfree" or "10% off".", "nullable": true}, "time_period_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of unique IDs for the catalog time periods when\nthis pricing rule is in effect. If left unset, the pricing rule is always\nin effect.", "nullable": true}, "discount_id": {"type": "string", "description": "Unique ID for the `CatalogDiscount` to take off\nthe price of all matched items.", "nullable": true}, "match_products_id": {"type": "string", "description": "Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule\nmatches within the entire cart, and can match multiple times. This field will always be set.", "nullable": true}, "apply_products_id": {"type": "string", "description": "__Deprecated__: Please use the `exclude_products_id` field to apply\nan exclude set instead. Exclude sets allow better control over quantity\nranges and offer more flexibility for which matched items receive a discount.\n\n`CatalogProductSet` to apply the pricing to.\nAn apply rule matches within the subset of the cart that fits the match rules (the match set).\nAn apply rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", "x-release-status": "DEPRECATED", "nullable": true}, "exclude_products_id": {"type": "string", "description": "`CatalogProductSet` to exclude from the pricing rule.\nAn exclude rule matches within the subset of the cart that fits the match rules (the match set).\nAn exclude rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", "nullable": true}, "valid_from_date": {"type": "string", "description": "Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).", "nullable": true}, "valid_from_local_time": {"type": "string", "description": "Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", "nullable": true}, "valid_until_date": {"type": "string", "description": "Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).", "nullable": true}, "valid_until_local_time": {"type": "string", "description": "Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", "nullable": true}, "exclude_strategy": {"type": "string", "enum": ["LEAST_EXPENSIVE", "MOST_EXPENSIVE"], "x-enum-elements": [{"name": "LEAST_EXPENSIVE", "description": "The least expensive matched products are excluded from the pricing. If\nthe pricing rule is set to exclude one product and multiple products in the\nmatch set qualify as least expensive, then one will be excluded at random.\n\nExcluding the least expensive product gives the best discount value to the buyer."}, {"name": "MOST_EXPENSIVE", "description": "The most expensive matched product is excluded from the pricing rule.\nIf multiple products have the same price and all qualify as least expensive,\none will be excluded at random.\n\nThis guarantees that the most expensive product is purchased at full price."}], "description": "Indicates which products matched by a CatalogPricingRule\nwill be excluded if the pricing rule uses an exclude set.", "x-release-status": "BETA"}, "minimum_order_subtotal_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_group_ids_any": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule.\nNotice that a group ID is generated by the Customers API.\nIf this field is not set, the specified discount applies to matched products sold to anyone whether the buyer\nhas a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount\napplies only to matched products sold to customers belonging to the specified customer groups.", "nullable": true}}}, "image_data": {"type": "object", "description": "An image file to use in Square catalogs. It can be associated with\n`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects.\nOnly the images on items and item variations are exposed in Dashboard.\nOnly the first image on an item is displayed in Square Point of Sale (SPOS).\nImages on items and variations are displayed through Square Online Store.\nImages on other object types are for use by 3rd party application developers.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).\nIt is not unique and should not be shown in a buyer facing context.", "nullable": true}, "url": {"type": "string", "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.", "nullable": true}, "caption": {"type": "string", "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).", "nullable": true}, "photo_studio_order_id": {"type": "string", "description": "The immutable order ID for this image object created by the Photo Studio service in Square Online Store.", "nullable": true}}}, "measurement_unit_data": {"type": "object", "description": "Represents the unit used to measure a `CatalogItemVariation` and\nspecifies the precision for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in quantities measured with this unit.\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 3", "nullable": true}}}, "subscription_plan_data": {"type": "object", "description": "Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["name"], "properties": {"name": {"type": "string", "description": "The name of the plan."}, "phases": {"type": "array", "items": {"type": "object", "description": "Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["cadence"], "properties": {"uid": {"type": "string", "description": "The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "cadence": {"type": "string", "enum": ["DAILY", "WEEKLY", "EVERY_TWO_WEEKS", "THIRTY_DAYS", "SIXTY_DAYS", "NINETY_DAYS", "MONTHLY", "EVERY_TWO_MONTHS", "QUARTERLY", "EVERY_FOUR_MONTHS", "EVERY_SIX_MONTHS", "ANNUAL", "EVERY_TWO_YEARS"], "x-enum-elements": [{"name": "DAILY", "description": "Once per day"}, {"name": "WEEKLY", "description": "Once per week"}, {"name": "EVERY_TWO_WEEKS", "description": "Every two weeks"}, {"name": "THIRTY_DAYS", "description": "Once every 30 days"}, {"name": "SIXTY_DAYS", "description": "Once every 60 days"}, {"name": "NINETY_DAYS", "description": "Once every 90 days"}, {"name": "MONTHLY", "description": "Once per month"}, {"name": "EVERY_TWO_MONTHS", "description": "Once every two months"}, {"name": "QUARTERLY", "description": "Once every three months"}, {"name": "EVERY_FOUR_MONTHS", "description": "Once every four months"}, {"name": "EVERY_SIX_MONTHS", "description": "Once every six months"}, {"name": "ANNUAL", "description": "Once per year"}, {"name": "EVERY_TWO_YEARS", "description": "Once every two years"}], "description": "Determines the billing cadence of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "periods": {"type": "integer", "description": "The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "recurring_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ordinal": {"type": "integer", "description": "The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.", "format": "int64", "nullable": true}, "pricing": {"type": "object", "description": "Describes the pricing for the subscription.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STATIC", "RELATIVE"], "x-enum-elements": [{"name": "STATIC", "description": "Static pricing"}, {"name": "RELATIVE", "description": "Relative pricing"}], "description": "Determines the pricing of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "discount_ids": {"type": "array", "items": {"type": "string"}, "description": "The ids of the discount catalog objects", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error", "nullable": true}, "subscription_plan_variations": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "The list of subscription plan variations available for this product", "nullable": true}, "eligible_item_ids": {"type": "array", "items": {"type": "string"}, "description": "The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan\'s variations.", "nullable": true}, "eligible_category_ids": {"type": "array", "items": {"type": "string"}, "description": "The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan\'s variations.", "nullable": true}, "all_items": {"type": "boolean", "description": "If true, all items in the merchant\'s catalog are subscribable by this SubscriptionPlan.", "nullable": true}}}, "item_option_data": {"type": "object", "description": "A group of variations for a `CatalogItem`.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The item option\'s display name for the seller. Must be unique across\nall item options. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "display_name": {"type": "string", "description": "The item option\'s display name for the customer. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "description": {"type": "string", "description": "The item option\'s human-readable description. Displayed in the Square\nPoint of Sale app for the seller and in the Online Store or on receipts for\nthe buyer. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "show_colors": {"type": "boolean", "description": "If true, display colors for entries in `values` when present.", "nullable": true}, "values": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A list of CatalogObjects containing the\n`CatalogItemOptionValue`s for this item.", "nullable": true}}}, "item_option_value_data": {"type": "object", "description": "An enumerated value that can link a\n`CatalogItemVariation` to an item option as one of\nits item option values.", "x-release-status": "PUBLIC", "properties": {"item_option_id": {"type": "string", "description": "Unique ID of the associated item option.", "nullable": true}, "name": {"type": "string", "description": "Name of this item option value. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "description": {"type": "string", "description": "A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "color": {"type": "string", "description": "The HTML-supported hex color for the item option (e.g., "#ff8d4e85").\nOnly displayed if `show_colors` is enabled on the parent `ItemOption`. When\nleft unset, `color` defaults to white ("#ffffff") when `show_colors` is\nenabled on the parent `ItemOption`.", "nullable": true}, "ordinal": {"type": "integer", "description": "Determines where this option value appears in a list of option values.", "nullable": true}}}, "custom_attribute_definition_data": {"type": "object", "description": "Contains information defining a custom attribute. Custom attributes are\nintended to store additional information about a catalog object or to associate a\ncatalog object with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)", "x-release-status": "PUBLIC", "required": ["type", "name", "allowed_object_types"], "properties": {"type": {"type": "string", "enum": ["STRING", "BOOLEAN", "NUMBER", "SELECTION"], "x-enum-elements": [{"name": "STRING", "description": "A free-form string containing up to 255 characters."}, {"name": "BOOLEAN", "description": "A `true` or `false` value."}, {"name": "NUMBER", "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point."}, {"name": "SELECTION", "description": "One or more choices from `allowed_selections`."}], "description": "Defines the possible types for a custom attribute.", "x-release-status": "PUBLIC"}, "name": {"type": "string", "description": " The name of this definition for API and seller-facing UI purposes.\nThe name must be unique within the (merchant, application) pair. Required.\nMay not be empty and may not exceed 255 characters. Can be modified after creation.", "minLength": 1, "maxLength": 255}, "description": {"type": "string", "description": "Seller-oriented description of the meaning of this Custom Attribute,\nany constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.", "maxLength": 255, "nullable": true}, "source_application": {"type": "object", "description": "Represents information about the application used to generate a change.", "x-release-status": "PUBLIC", "properties": {"product": {"type": "string", "enum": ["SQUARE_POS", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "DASHBOARD", "ITEM_LIBRARY_IMPORT", "OTHER"], "x-enum-elements": [{"name": "SQUARE_POS", "description": "Square Point of Sale application."}, {"name": "EXTERNAL_API", "description": "Square Connect APIs (for example, Orders API or Checkout API)."}, {"name": "BILLING", "description": "A Square subscription (various products)."}, {"name": "APPOINTMENTS", "description": "Square Appointments."}, {"name": "INVOICES", "description": "Square Invoices."}, {"name": "ONLINE_STORE", "description": "Square Online Store."}, {"name": "PAYROLL", "description": "Square Payroll."}, {"name": "DASHBOARD", "description": "Square Dashboard."}, {"name": "ITEM_LIBRARY_IMPORT", "description": "Item Library Import."}, {"name": "OTHER", "description": "A Square product that does not match any other value."}], "description": "Indicates the Square product used to generate a change.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", "nullable": true}, "name": {"type": "string", "description": "__Read only__ The display name of the application\n(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).", "nullable": true}}}, "allowed_object_types": {"type": "array", "items": {"type": "string", "enum": ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER", "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD", "MEASUREMENT_UNIT", "SUBSCRIPTION_PLAN_VARIATION", "ITEM_OPTION", "ITEM_OPTION_VAL", "CUSTOM_ATTRIBUTE_DEFINITION", "QUICK_AMOUNTS_SETTINGS", "SUBSCRIPTION_PLAN", "AVAILABILITY_PERIOD"], "x-enum-elements": [{"name": "ITEM", "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field."}, {"name": "IMAGE", "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field."}, {"name": "CATEGORY", "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field."}, {"name": "ITEM_VARIATION", "description": "The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field."}, {"name": "TAX", "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field."}, {"name": "DISCOUNT", "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field."}, {"name": "MODIFIER_LIST", "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field."}, {"name": "MODIFIER", "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field."}, {"name": "PRICING_RULE", "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field."}, {"name": "PRODUCT_SET", "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field."}, {"name": "TIME_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field."}, {"name": "MEASUREMENT_UNIT", "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field."}, {"name": "SUBSCRIPTION_PLAN_VARIATION", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field."}, {"name": "ITEM_OPTION", "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field."}, {"name": "ITEM_OPTION_VAL", "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of "Size" may have item option values such as "Small" or "Medium".\nThe item-option-value-specific data must be on the `item_option_value_data` field."}, {"name": "CUSTOM_ATTRIBUTE_DEFINITION", "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field."}, {"name": "QUICK_AMOUNTS_SETTINGS", "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field."}, {"name": "SUBSCRIPTION_PLAN", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field."}, {"name": "AVAILABILITY_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field."}], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", "x-release-status": "PUBLIC"}, "description": "The set of `CatalogObject` types that this custom atttribute may be applied to.\nCurrently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included.\nSee [CatalogObjectType](#type-catalogobjecttype) for possible values"}, "seller_visibility": {"type": "string", "enum": ["SELLER_VISIBILITY_HIDDEN", "SELLER_VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "SELLER_VISIBILITY_HIDDEN", "description": "Sellers cannot read this custom attribute in Square client\napplications or Square APIs."}, {"name": "SELLER_VISIBILITY_READ_WRITE_VALUES", "description": "Sellers can read and write this custom attribute value in catalog objects,\nbut cannot edit the custom attribute definition."}], "description": "Defines the visibility of a custom attribute to sellers in Square\nclient applications, Square APIs or in Square UIs (including Square Point\nof Sale applications and Square Dashboard).", "x-release-status": "PUBLIC"}, "app_visibility": {"type": "string", "enum": ["APP_VISIBILITY_HIDDEN", "APP_VISIBILITY_READ_ONLY", "APP_VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "APP_VISIBILITY_HIDDEN", "description": "Other applications cannot read this custom attribute."}, {"name": "APP_VISIBILITY_READ_ONLY", "description": "Other applications can read this custom attribute definition and\nvalues."}, {"name": "APP_VISIBILITY_READ_WRITE_VALUES", "description": "Other applications can read and write custom attribute values on objects.\nThey can read but cannot edit the custom attribute definition."}], "description": "Defines the visibility of a custom attribute to applications other than their\ncreating application.", "x-release-status": "PUBLIC"}, "string_config": {"type": "object", "description": "Configuration associated with Custom Attribute Definitions of type `STRING`.", "x-release-status": "PUBLIC", "properties": {"enforce_uniqueness": {"type": "boolean", "description": "If true, each Custom Attribute instance associated with this Custom Attribute\nDefinition must have a unique value within the seller\'s catalog. For\nexample, this may be used for a value like a SKU that should not be\nduplicated within a seller\'s catalog. May not be modified after the\ndefinition has been created.", "nullable": true}}}, "number_config": {"type": "object", "x-release-status": "PUBLIC", "properties": {"precision": {"type": "integer", "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in number custom attribute values\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 5", "maximum": 5, "nullable": true}}}, "selection_config": {"type": "object", "description": "Configuration associated with `SELECTION`-type custom attribute definitions.", "x-release-status": "PUBLIC", "properties": {"max_allowed_selections": {"type": "integer", "description": "The maximum number of selections that can be set. The maximum value for this\nattribute is 100. The default value is 1. The value can be modified, but changing the value will not\naffect existing custom attribute values on objects. Clients need to\nhandle custom attributes with more selected values than allowed by this limit.", "maximum": 100, "nullable": true}, "allowed_selections": {"type": "array", "items": {"type": "object", "description": "A named selection for this `SELECTION`-type custom attribute definition.", "x-release-status": "PUBLIC", "required": ["name"], "properties": {"uid": {"type": "string", "description": "Unique ID set by Square.", "nullable": true}, "name": {"type": "string", "description": "Selection name, unique within `allowed_selections`.", "minLength": 1, "maxLength": 255}}}, "description": "The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100\nselections can be defined. Can be modified.", "nullable": true}}}, "custom_attribute_usage_count": {"type": "integer", "description": "The number of custom attributes that reference this\ncustom attribute definition. Set by the server in response to a ListCatalog\nrequest with `include_counts` set to `true`.  If the actual count is greater\nthan 100, `custom_attribute_usage_count` will be set to `100`.", "readOnly": true}, "key": {"type": "string", "description": "The name of the desired custom attribute key that can be used to access\nthe custom attribute value on catalog objects. Cannot be modified after the\ncustom attribute definition has been created.\nMust be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.", "minLength": 1, "maxLength": 60, "pattern": "^[a-zA-Z0-9_-]*$", "nullable": true}}}, "quick_amounts_settings_data": {"type": "object", "description": "A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.", "x-release-status": "BETA", "required": ["option"], "properties": {"option": {"type": "string", "enum": ["DISABLED", "MANUAL", "AUTO"], "x-enum-elements": [{"name": "DISABLED", "description": "Option for seller to disable Quick Amounts."}, {"name": "MANUAL", "description": "Option for seller to choose manually created Quick Amounts."}, {"name": "AUTO", "description": "Option for seller to choose automatically created Quick Amounts."}], "description": "Determines a seller\'s option on Quick Amounts feature.", "x-release-status": "BETA"}, "eligible_for_auto_amounts": {"type": "boolean", "description": "Represents location\'s eligibility for auto amounts\nThe boolean should be consistent with whether there are AUTO amounts in the `amounts`.", "nullable": true}, "amounts": {"type": "array", "items": {"type": "object", "description": "Represents a Quick Amount in the Catalog.", "x-release-status": "BETA", "required": ["type", "amount"], "properties": {"type": {"type": "string", "enum": ["QUICK_AMOUNT_TYPE_MANUAL", "QUICK_AMOUNT_TYPE_AUTO"], "x-enum-elements": [{"name": "QUICK_AMOUNT_TYPE_MANUAL", "description": "Quick Amount is created manually by the seller."}, {"name": "QUICK_AMOUNT_TYPE_AUTO", "description": "Quick Amount is generated automatically by machine learning algorithms."}], "description": "Determines the type of a specific Quick Amount.", "x-release-status": "BETA"}, "amount": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "score": {"type": "integer", "description": "Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].\nMANUAL type amount will always have score = 100.", "format": "int64", "nullable": true}, "ordinal": {"type": "integer", "description": "The order in which this Quick Amount should be displayed.", "format": "int64", "nullable": true}}}, "description": "Represents a set of Quick Amounts at this location.", "nullable": true}}}, "subscription_plan_variation_data": {"type": "object", "description": "Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["name", "phases"], "properties": {"name": {"type": "string", "description": "The name of the plan variation."}, "phases": {"type": "array", "items": {"type": "object", "description": "Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["cadence"], "properties": {"uid": {"type": "string", "description": "The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "cadence": {"type": "string", "enum": ["DAILY", "WEEKLY", "EVERY_TWO_WEEKS", "THIRTY_DAYS", "SIXTY_DAYS", "NINETY_DAYS", "MONTHLY", "EVERY_TWO_MONTHS", "QUARTERLY", "EVERY_FOUR_MONTHS", "EVERY_SIX_MONTHS", "ANNUAL", "EVERY_TWO_YEARS"], "x-enum-elements": [{"name": "DAILY", "description": "Once per day"}, {"name": "WEEKLY", "description": "Once per week"}, {"name": "EVERY_TWO_WEEKS", "description": "Every two weeks"}, {"name": "THIRTY_DAYS", "description": "Once every 30 days"}, {"name": "SIXTY_DAYS", "description": "Once every 60 days"}, {"name": "NINETY_DAYS", "description": "Once every 90 days"}, {"name": "MONTHLY", "description": "Once per month"}, {"name": "EVERY_TWO_MONTHS", "description": "Once every two months"}, {"name": "QUARTERLY", "description": "Once every three months"}, {"name": "EVERY_FOUR_MONTHS", "description": "Once every four months"}, {"name": "EVERY_SIX_MONTHS", "description": "Once every six months"}, {"name": "ANNUAL", "description": "Once per year"}, {"name": "EVERY_TWO_YEARS", "description": "Once every two years"}], "description": "Determines the billing cadence of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "periods": {"type": "integer", "description": "The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "recurring_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ordinal": {"type": "integer", "description": "The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.", "format": "int64", "nullable": true}, "pricing": {"type": "object", "description": "Describes the pricing for the subscription.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STATIC", "RELATIVE"], "x-enum-elements": [{"name": "STATIC", "description": "Static pricing"}, {"name": "RELATIVE", "description": "Relative pricing"}], "description": "Determines the pricing of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "discount_ids": {"type": "array", "items": {"type": "string"}, "description": "The ids of the discount catalog objects", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation."}, "subscription_plan_id": {"type": "string", "description": "The id of the subscription plan, if there is one.", "nullable": true}, "monthly_billing_anchor_date": {"type": "integer", "description": "The day of the month the billing period starts.", "format": "int64", "minimum": 1, "maximum": 31, "nullable": true}, "can_prorate": {"type": "boolean", "description": "Whether bills for this plan variation can be split for proration.", "nullable": true}, "successor_plan_variation_id": {"type": "string", "description": "The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all\nlocations, it indicates that this variation is deprecated and the object identified by the successor ID be used in\nits stead.", "nullable": true}}}, "availability_period_data": {"type": "object", "description": "Represents a time period of availability.", "x-release-status": "BETA", "properties": {"start_local_time": {"type": "string", "description": "The start time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "end_local_time": {"type": "string", "description": "The end time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "day_of_week": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"], "x-enum-elements": [{"name": "SUN", "description": "Sunday"}, {"name": "MON", "description": "Monday"}, {"name": "TUE", "description": "Tuesday"}, {"name": "WED", "description": "Wednesday"}, {"name": "THU", "description": "Thursday"}, {"name": "FRI", "description": "Friday"}, {"name": "SAT", "description": "Saturday"}], "description": "Indicates the specific day  of the week.", "x-release-status": "PUBLIC"}}}}, "example": {"catalog_object": {"absent_at_location_ids": ["{{ LOCATIONID-1 }}", "{{ LOCATIONID-N }}"], "category_data": "{{ CatalogCategory object only if type=CATEGORY }}", "connect_v1_ids": {"catalog_v1_id": "{{ itemID from Catalog v1 }}", "location_id": "{{ location where v1 ID is used }}"}, "discount_data": "{{ CatalogDiscount object only if type=DISCOUNT }}", "id": "{{ set by Catalog during object creation }}", "is_deleted": "{{ [true | false] }}", "item_data": "{{ CatalogItem object only if type=ITEM }}", "item_variation_data": "{{ CatalogItemVariation object only if type=ITEM_VARIATION }}", "modifier_data": "{{ CatalogModifier object only if type=MODIFIER }}", "modifier_list_data": "{{ CatalogModifierList object only if type=MODIFIER_LIST }}", "present_at_all_locations": "{{ [true | false] }}", "present_at_location_ids": ["{{ LOCATIONID-1 }}", "{{ LOCATIONID-N }}"], "tax_data": "{{ CatalogTax object only if type=TAX }}", "type": "{{ [ITEM | ITEM_VARIATION | MODIFIER | MODIFIER_LIST | CATEGORY | DISCOUNT | TAX] }}", "updated_at": "{{ date & time of most recent update }}", "version": "{{ version of the CatalogObject }}"}}}, "description": "A list of CatalogObjects belonging to this batch."}}}, "description": "A batch of CatalogObjects to be inserted/updated atomically.\nThe objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs\nattempting to insert or update an object within a batch, the entire batch will be rejected. However, an error\nin one batch will not affect other batches within the same request.\n\nFor each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its\n`is_deleted` field must not be set to `true`.\n\nTo modify an existing object, supply its ID. To create a new object, use an ID starting\nwith `#`. These IDs may be used to create relationships between an object and attributes of\nother objects that reference it. For example, you can create a CatalogItem with\nID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to\n`#ABC` in order to associate the CatalogItemVariation with its parent\nCatalogItem.\n\nAny `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.\n\nEach batch may contain up to 1,000 objects. The total number of objects across all batches for a single request\nmay not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will\nbe inserted or updated."}}, "example": {"batches": [{"objects": [{"id": "#Tea", "item_data": {"categories": [{"id": "#Beverages"}], "description_html": "<p><strong>Hot</strong> Leaf Juice</p>", "name": "Tea", "tax_ids": ["#SalesTax"], "variations": [{"id": "#Tea_Mug", "item_variation_data": {"item_id": "#Tea", "name": "Mug", "price_money": {"amount": 150, "currency": "USD"}, "pricing_type": "FIXED_PRICING"}, "present_at_all_locations": true, "type": "ITEM_VARIATION"}]}, "present_at_all_locations": true, "type": "ITEM"}, {"id": "#Coffee", "item_data": {"categories": [{"id": "#Beverages"}], "description_html": "<p>Hot <em>Bean Juice</em></p>", "name": "Coffee", "tax_ids": ["#SalesTax"], "variations": [{"id": "#Coffee_Regular", "item_variation_data": {"item_id": "#Coffee", "name": "Regular", "price_money": {"amount": 250, "currency": "USD"}, "pricing_type": "FIXED_PRICING"}, "present_at_all_locations": true, "type": "ITEM_VARIATION"}, {"id": "#Coffee_Large", "item_variation_data": {"item_id": "#Coffee", "name": "Large", "price_money": {"amount": 350, "currency": "USD"}, "pricing_type": "FIXED_PRICING"}, "present_at_all_locations": true, "type": "ITEM_VARIATION"}]}, "present_at_all_locations": true, "type": "ITEM"}, {"category_data": {"name": "Beverages"}, "id": "#Beverages", "present_at_all_locations": true, "type": "CATEGORY"}, {"id": "#SalesTax", "present_at_all_locations": true, "tax_data": {"applies_to_custom_amounts": true, "calculation_phase": "TAX_SUBTOTAL_PHASE", "enabled": true, "inclusion_type": "ADDITIVE", "name": "Sales Tax", "percentage": "5.0"}, "type": "TAX"}]}], "idempotency_key": "789ff020-f723-43a9-b4b5-43b5dc1fa3dc"}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.csharp", "java": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.java", "javascript": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.javascript", "php": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.php", "python": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.python", "ruby": "/sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.ruby"}}',  # noqa: E501
    "UPSERTCATALOGOBJECT": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key", "object"], "properties": {"idempotency_key": {"type": "string", "description": "A value you specify that uniquely identifies this\nrequest among all your requests. A common way to create\na valid idempotency key is to use a Universally unique\nidentifier (UUID).\n\nIf you\'re unsure whether a particular request was successful,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate objects.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1, "maxLength": 128}, "object": {"type": "object", "description": "The wrapper object for the catalog entries of a given object type.\n\nDepending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.\n\nFor example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.\n\nIn general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance.\n\nFor a more detailed discussion of the Catalog data model, please see the\n[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.", "x-release-status": "PUBLIC", "required": ["type", "id"], "properties": {"type": {"type": "string", "enum": ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER", "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD", "MEASUREMENT_UNIT", "SUBSCRIPTION_PLAN_VARIATION", "ITEM_OPTION", "ITEM_OPTION_VAL", "CUSTOM_ATTRIBUTE_DEFINITION", "QUICK_AMOUNTS_SETTINGS", "SUBSCRIPTION_PLAN", "AVAILABILITY_PERIOD"], "x-enum-elements": [{"name": "ITEM", "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field."}, {"name": "IMAGE", "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field."}, {"name": "CATEGORY", "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field."}, {"name": "ITEM_VARIATION", "description": "The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field."}, {"name": "TAX", "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field."}, {"name": "DISCOUNT", "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field."}, {"name": "MODIFIER_LIST", "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field."}, {"name": "MODIFIER", "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field."}, {"name": "PRICING_RULE", "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field."}, {"name": "PRODUCT_SET", "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field."}, {"name": "TIME_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field."}, {"name": "MEASUREMENT_UNIT", "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field."}, {"name": "SUBSCRIPTION_PLAN_VARIATION", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field."}, {"name": "ITEM_OPTION", "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field."}, {"name": "ITEM_OPTION_VAL", "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of "Size" may have item option values such as "Small" or "Medium".\nThe item-option-value-specific data must be on the `item_option_value_data` field."}, {"name": "CUSTOM_ATTRIBUTE_DEFINITION", "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field."}, {"name": "QUICK_AMOUNTS_SETTINGS", "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field."}, {"name": "SUBSCRIPTION_PLAN", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field."}, {"name": "AVAILABILITY_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field."}], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", "x-release-status": "PUBLIC"}, "id": {"type": "string", "description": "An identifier to reference this object in the catalog. When a new `CatalogObject`\nis inserted, the client should set the id to a temporary identifier starting with\na "`#`" character. Other objects being inserted or updated within the same request\nmay use this identifier to refer to the new object.\n\nWhen the server receives the new object, it will supply a unique identifier that\nreplaces the temporary identifier for all future references.", "minLength": 1}, "updated_at": {"type": "string", "description": "Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"`\nwould indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.", "readOnly": true}, "version": {"type": "integer", "description": "The version of the object. When updating an object, the version supplied\nmust match the version in the database, otherwise the write will be rejected as conflicting.", "format": "int64"}, "is_deleted": {"type": "boolean", "description": "If `true`, the object has been deleted from the database. Must be `false` for new objects\nbeing inserted. When deleted, the `updated_at` field will equal the deletion time.", "nullable": true}, "custom_attribute_values": {"type": "object", "additionalProperties": {"type": "object", "description": "An instance of a custom attribute. Custom attributes can be defined and\nadded to `ITEM` and `ITEM_VARIATION` type catalog objects.\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes).", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name of the custom attribute.", "nullable": true}, "string_value": {"type": "string", "description": "The string value of the custom attribute.  Populated if `type` = `STRING`.", "nullable": true}, "custom_attribute_definition_id": {"type": "string", "description": "The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to.", "readOnly": true}, "type": {"type": "string", "enum": ["STRING", "BOOLEAN", "NUMBER", "SELECTION"], "x-enum-elements": [{"name": "STRING", "description": "A free-form string containing up to 255 characters."}, {"name": "BOOLEAN", "description": "A `true` or `false` value."}, {"name": "NUMBER", "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point."}, {"name": "SELECTION", "description": "One or more choices from `allowed_selections`."}], "description": "Defines the possible types for a custom attribute.", "x-release-status": "PUBLIC"}, "number_value": {"type": "string", "description": "Populated if `type` = `NUMBER`. Contains a string\nrepresentation of a decimal number, using a `.` as the decimal separator.", "nullable": true}, "boolean_value": {"type": "boolean", "description": "A `true` or `false` value. Populated if `type` = `BOOLEAN`.", "nullable": true}, "selection_uid_values": {"type": "array", "items": {"type": "string"}, "description": "One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.", "nullable": true}, "key": {"type": "string", "description": "If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID.\nFor example, if the CatalogCustomAttributeDefinition has a key attribute of "cocoa_brand" and the defining application ID is "abcd1234", this key is "abcd1234:cocoa_brand"\nwhen the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand".", "readOnly": true}}}, "description": "A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair\nis a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute\nvalue defined in the associated [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition)\nobject defined by the application making the request.\n\nIf the `CatalogCustomAttributeDefinition` object is\ndefined by another application, the `CatalogCustomAttributeDefinition`\'s key attribute value is prefixed by\nthe defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of\n`"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"`\nif the application making the request is different from the application defining the custom attribute definition.\nOtherwise, the key used in the map is simply `"cocoa_brand"`.\n\nApplication-defined custom attributes are set at a global (location-independent) level.\nCustom attribute values are intended to store additional information about a catalog object\nor associations with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).", "nullable": true}, "catalog_v1_ids": {"type": "array", "items": {"type": "object", "description": "A Square API V1 identifier of an item, including the object ID and its associated location ID.", "x-release-status": "PUBLIC", "properties": {"catalog_v1_id": {"type": "string", "description": "The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID.", "nullable": true}, "location_id": {"type": "string", "description": "The ID of the `Location` this Connect V1 ID is associated with.", "nullable": true}}}, "description": "The Connect v1 IDs for this object at each location where it is present, where they\ndiffer from the object\'s Connect V2 ID. The field will only be present for objects that\nhave been created or modified by legacy APIs.", "nullable": true}, "present_at_all_locations": {"type": "boolean", "description": "If `true`, this object is present at all locations (including future locations), except where specified in\nthe `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations),\nexcept where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.", "nullable": true}, "present_at_location_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of locations where the object is present, even if `present_at_all_locations` is `false`.\nThis can include locations that are deactivated.", "nullable": true}, "absent_at_location_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of locations where the object is not present, even if `present_at_all_locations` is `true`.\nThis can include locations that are deactivated.", "nullable": true}, "item_data": {"type": "object", "description": "A [CatalogObject](entity:CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The item\'s name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.", "maxLength": 512, "nullable": true}, "description": {"type": "string", "description": "The item\'s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.\n\nDeprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description\nof the [CatalogItem](entity:CatalogItem) instance.  The `description` and `description_html` field values are kept in sync. If you try to\nset the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,\nexcept for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null\ndoes not nullify `description_html`.", "maxLength": 4096, "x-release-status": "DEPRECATED", "nullable": true}, "abbreviation": {"type": "string", "description": "The text of the item\'s display label in the Square Point of Sale app. Only up to the first five characters of the string are used.\nThis attribute is searchable, and its value length is of Unicode code points.", "maxLength": 24, "nullable": true}, "label_color": {"type": "string", "description": "The color of the item\'s display label in the Square Point of Sale app. This must be a valid hex color code.", "nullable": true}, "is_taxable": {"type": "boolean", "description": "Indicates whether the item is taxable (`true`) or non-taxable (`false`). Default is `true`.", "nullable": true}, "category_id": {"type": "string", "description": "The ID of the item\'s category, if any. Deprecated since 2023-12-13. Use `CatalogItem.categories`, instead.", "x-release-status": "DEPRECATED", "nullable": true}, "tax_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of IDs indicating the taxes enabled for\nthis item. When updating an item, any taxes listed here will be added to the item.\nTaxes may also be added to or deleted from an item using `UpdateItemTaxes`.", "nullable": true}, "modifier_list_info": {"type": "array", "items": {"type": "object", "description": "Controls how a modifier list is applied to a specific item. This object allows for item-specific customization of modifier list behavior\nand provides the ability to override global modifier list settings.", "x-release-status": "PUBLIC", "required": ["modifier_list_id"], "properties": {"modifier_list_id": {"type": "string", "description": "The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.", "minLength": 1}, "modifier_overrides": {"type": "array", "items": {"type": "object", "description": "Options to control how to override the default behavior of the specified modifier.", "x-release-status": "PUBLIC", "required": ["modifier_id"], "properties": {"modifier_id": {"type": "string", "description": "The ID of the `CatalogModifier` whose default behavior is being overridden.", "minLength": 1}, "on_by_default": {"type": "boolean", "description": "__Deprecated__: Use `on_by_default_override` instead.", "x-release-status": "DEPRECATED", "nullable": true}, "hidden_online_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "on_by_default_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}}}, "description": "A set of `CatalogModifierOverride` objects that override default modifier settings for this item.", "nullable": true}, "min_selected_modifiers": {"type": "integer", "description": "The minimum number of modifiers that must be selected from this modifier list.\nValues:\n\n- 0: No selection is required.\n- -1: Default value, the attribute was not set by the client. When `max_selected_modifiers` is\nalso -1, use the minimum and maximum selection values set on the `CatalogItemModifierList`.\n- &gt;0: The required minimum modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no selection required.", "nullable": true}, "max_selected_modifiers": {"type": "integer", "description": "The maximum number of modifiers that can be selected.\nValues:\n\n- 0: No maximum limit.\n- -1: Default value, the attribute was not set by the client. When `min_selected_modifiers` is\nalso -1, use the minimum and maximum selection values set on the `CatalogItemModifierList`.\n- &gt;0: The maximum total modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no maximum limit.", "nullable": true}, "enabled": {"type": "boolean", "description": "If `true`, enable this `CatalogModifierList`. The default value is `true`.", "nullable": true}, "ordinal": {"type": "integer", "description": "The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied \nto a `CatalogItem` instance.", "x-release-status": "BETA", "nullable": true}, "allow_quantities": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "is_conversational": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}, "hidden_from_customer_override": {"type": "object", "description": "Schema reference broken: #/components/schemas/CatalogModifierToggleOverrideType", "additionalProperties": true, "x-moar-broken-reference": "#/components/schemas/CatalogModifierToggleOverrideType"}}}, "description": "A set of `CatalogItemModifierListInfo` objects\nrepresenting the modifier lists that apply to this item, along with the overrides and min\nand max limits that are specific to this item. Modifier lists\nmay also be added to or deleted from an item using `UpdateItemModifierLists`.", "nullable": true}, "variations": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have\nat least one variation.", "nullable": true}, "product_type": {"type": "string", "enum": ["REGULAR", "GIFT_CARD", "APPOINTMENTS_SERVICE", "FOOD_AND_BEV", "EVENT", "DIGITAL", "DONATION", "LEGACY_SQUARE_ONLINE_SERVICE", "LEGACY_SQUARE_ONLINE_MEMBERSHIP"], "x-enum-elements": [{"name": "REGULAR", "description": "An ordinary item."}, {"name": "GIFT_CARD", "description": "A Square gift card."}, {"name": "APPOINTMENTS_SERVICE", "description": "A service that can be booked using the Square Appointments app."}, {"name": "FOOD_AND_BEV", "description": "A food or beverage item that can be sold by restaurants and other food venues."}, {"name": "EVENT", "description": "An event which tickets can be sold for, including location, address, and times."}, {"name": "DIGITAL", "description": "A digital item like an ebook or song."}, {"name": "DONATION", "description": "A donation which site visitors can send for any cause."}, {"name": "LEGACY_SQUARE_ONLINE_SERVICE", "description": "A legacy Square Online service that is manually fulfilled. This corresponds to the `Other` item type displayed in the Square Seller Dashboard and Square POS apps."}, {"name": "LEGACY_SQUARE_ONLINE_MEMBERSHIP", "description": "A legacy Square Online membership that is manually fulfilled. This corresponds to the `Membership` item type displayed in the Square Seller Dashboard and Square POS apps."}], "description": "The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.", "x-release-status": "PUBLIC"}, "skip_modifier_screen": {"type": "boolean", "description": "If `false`, the Square Point of Sale app will present the `CatalogItem`\'s\ndetails screen immediately, allowing the merchant to choose `CatalogModifier`s\nbefore adding the item to the cart.  This is the default behavior.\n\nIf `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected\nmodifiers, and merchants can edit modifiers by drilling down onto the item\'s details.\n\nThird-party clients are encouraged to implement similar behaviors.", "nullable": true}, "item_options": {"type": "array", "items": {"type": "object", "description": " An option that can be assigned to an item.\nFor example, a t-shirt item may offer a color option or a size option.", "x-release-status": "BETA", "properties": {"item_option_id": {"type": "string", "description": "The unique id of the item option, used to form the dimensions of the item option matrix in a specified order.", "nullable": true}}}, "description": "List of item options IDs for this item. Used to manage and group item\nvariations in a specified order.\n\nMaximum: 6 item options.", "nullable": true}, "ecom_uri": {"type": "string", "description": "Deprecated. A URI pointing to a published e-commerce product page for the Item.", "x-release-status": "DEPRECATED", "nullable": true}, "ecom_image_uris": {"type": "array", "items": {"type": "string"}, "description": "Deprecated. A comma-separated list of encoded URIs pointing to a set of published e-commerce images for the Item.", "x-release-status": "DEPRECATED", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogItem` instance.\nThese images will be shown to customers in Square Online Store.\nThe first image will show up as the icon for this item in POS.", "x-release-status": "BETA", "nullable": true}, "sort_name": {"type": "string", "description": "A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting.\nIts value must not be empty.\n\nIt is currently supported for sellers of the Japanese locale only.", "x-release-status": "BETA", "nullable": true}, "categories": {"type": "array", "items": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "description": "The list of categories.", "nullable": true}, "description_html": {"type": "string", "description": "The item\'s description as expressed in valid HTML elements. The length of this field value, including those of HTML tags,\nis of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or\nunsupported HTML elements or attributes are ignored.\n\nSupported HTML elements include:\n- `a`: Link. Supports linking to website URLs, email address, and telephone numbers.\n- `b`, `strong`:  Bold text\n- `br`: Line break\n- `code`: Computer code\n- `div`: Section\n- `h1-h6`: Headings\n- `i`, `em`: Italics\n- `li`: List element\n- `ol`: Numbered list\n- `p`: Paragraph\n- `ul`: Bullet list\n- `u`: Underline\n\n\nSupported HTML attributes include:\n- `align`: Alignment of the text content\n- `href`: Link destination\n- `rel`: Relationship between link\'s target and source\n- `target`: Place to open the linked document", "maxLength": 65535, "nullable": true}, "description_plaintext": {"type": "string", "description": "A server-generated plaintext version of the `description_html` field, without formatting tags.", "maxLength": 65535, "readOnly": true}, "channels": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.\nThis field is read only and cannot be edited.", "nullable": true}, "is_archived": {"type": "boolean", "description": "Indicates whether this item is archived (`true`) or not (`false`).", "nullable": true}, "ecom_seo_data": {"type": "object", "description": "SEO data for for a seller\'s Square Online store.", "x-release-status": "PUBLIC", "properties": {"page_title": {"type": "string", "description": "The SEO title used for the Square Online store.", "nullable": true}, "page_description": {"type": "string", "description": "The SEO description used for the Square Online store.", "nullable": true}, "permalink": {"type": "string", "description": "The SEO permalink used for the Square Online store.", "nullable": true}}}, "food_and_beverage_details": {"type": "object", "description": "The food and beverage-specific details of a `FOOD_AND_BEV` item.", "x-release-status": "PUBLIC", "properties": {"calorie_count": {"type": "integer", "description": "The calorie count (in the unit of kcal) for the `FOOD_AND_BEV` type of items.", "nullable": true}, "dietary_preferences": {"type": "array", "items": {"type": "object", "description": "Dietary preferences that can be assigned to an `FOOD_AND_BEV` item and its ingredients.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STANDARD", "CUSTOM"], "x-enum-elements": [{"name": "STANDARD", "description": "A standard value from a pre-determined list."}, {"name": "CUSTOM", "description": "A user-defined custom value."}], "description": "The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.", "x-release-status": "PUBLIC"}, "standard_name": {"type": "string", "enum": ["DAIRY_FREE", "GLUTEN_FREE", "HALAL", "KOSHER", "NUT_FREE", "VEGAN", "VEGETARIAN"], "x-enum-elements": [{"name": "DAIRY_FREE", "description": ""}, {"name": "GLUTEN_FREE", "description": ""}, {"name": "HALAL", "description": ""}, {"name": "KOSHER", "description": ""}, {"name": "NUT_FREE", "description": ""}, {"name": "VEGAN", "description": ""}, {"name": "VEGETARIAN", "description": ""}], "description": "Standard dietary preferences for food and beverage items that are recommended on item creation.", "x-release-status": "PUBLIC"}, "custom_name": {"type": "string", "description": "The name of a user-defined custom dietary preference. This should be null if it\'s a standard dietary preference.", "nullable": true}}}, "description": "The dietary preferences for the `FOOD_AND_BEV` item.", "nullable": true}, "ingredients": {"type": "array", "items": {"type": "object", "description": "Describes the ingredient used in a `FOOD_AND_BEV` item.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STANDARD", "CUSTOM"], "x-enum-elements": [{"name": "STANDARD", "description": "A standard value from a pre-determined list."}, {"name": "CUSTOM", "description": "A user-defined custom value."}], "description": "The type of dietary preference for the `FOOD_AND_BEV` type of items and integredients.", "x-release-status": "PUBLIC"}, "standard_name": {"type": "string", "enum": ["CELERY", "CRUSTACEANS", "EGGS", "FISH", "GLUTEN", "LUPIN", "MILK", "MOLLUSCS", "MUSTARD", "PEANUTS", "SESAME", "SOY", "SULPHITES", "TREE_NUTS"], "x-enum-elements": [{"name": "CELERY", "description": ""}, {"name": "CRUSTACEANS", "description": ""}, {"name": "EGGS", "description": ""}, {"name": "FISH", "description": ""}, {"name": "GLUTEN", "description": ""}, {"name": "LUPIN", "description": ""}, {"name": "MILK", "description": ""}, {"name": "MOLLUSCS", "description": ""}, {"name": "MUSTARD", "description": ""}, {"name": "PEANUTS", "description": ""}, {"name": "SESAME", "description": ""}, {"name": "SOY", "description": ""}, {"name": "SULPHITES", "description": ""}, {"name": "TREE_NUTS", "description": ""}], "description": "Standard ingredients for food and beverage items that are recommended on item creation.", "x-release-status": "PUBLIC"}, "custom_name": {"type": "string", "description": "The name of a custom user-defined ingredient. This should be null if it\'s a standard dietary preference.", "nullable": true}}}, "description": "The ingredients for the `FOOD_AND_BEV` type item.", "nullable": true}}}, "reporting_category": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "is_alcoholic": {"type": "boolean", "description": "Indicates whether this item is alcoholic (`true`) or not (`false`).", "nullable": true}}, "example": {"object": {"id": "#Cocoa", "item_data": {"abbreviation": "Ch", "description": "Hot chocolate", "name": "Cocoa", "visibility": "PRIVATE"}, "present_at_all_locations": true, "type": "ITEM"}}}, "category_data": {"type": "object", "description": "A category to which a `CatalogItem` instance belongs.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogCategory` instance.\nCurrently these images are not displayed by Square, but are free to be displayed in 3rd party applications.", "nullable": true}, "category_type": {"type": "string", "enum": ["REGULAR_CATEGORY", "MENU_CATEGORY", "KITCHEN_CATEGORY"], "x-enum-elements": [{"name": "REGULAR_CATEGORY", "description": "The regular category."}, {"name": "MENU_CATEGORY", "description": "The menu category."}, {"name": "KITCHEN_CATEGORY", "description": "Kitchen categories are used by KDS (Kitchen Display System) to route items to specific clients"}], "description": "Indicates the type of a category.", "x-release-status": "PUBLIC"}, "parent_category": {"type": "object", "description": "A category that can be assigned to an item or a parent category that can be assigned \nto another category. For example, a clothing category can be assigned to a t-shirt item or \nbe made as the parent category to the pants category.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of the object\'s category."}, "ordinal": {"type": "integer", "description": "The order of the object within the context of the category.", "format": "int64", "nullable": true}}}, "is_top_level": {"type": "boolean", "description": "Indicates whether a category is a top level category, which does not have any parent_category.", "nullable": true}, "channels": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs representing channels, such as a Square Online site, where the category can be made visible.", "nullable": true}, "availability_period_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the `CatalogAvailabilityPeriod` objects associated with the category.", "nullable": true}, "online_visibility": {"type": "boolean", "description": "Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller\'s Square Online sites.", "nullable": true}, "root_category": {"type": "string", "description": "The top-level category in a category hierarchy.", "readOnly": true}, "ecom_seo_data": {"type": "object", "description": "SEO data for for a seller\'s Square Online store.", "x-release-status": "PUBLIC", "properties": {"page_title": {"type": "string", "description": "The SEO title used for the Square Online store.", "nullable": true}, "page_description": {"type": "string", "description": "The SEO description used for the Square Online store.", "nullable": true}, "permalink": {"type": "string", "description": "The SEO permalink used for the Square Online store.", "nullable": true}}}, "path_to_root": {"type": "array", "items": {"type": "object", "description": "A node in the path from a retrieved category to its root node.", "x-release-status": "PUBLIC", "properties": {"category_id": {"type": "string", "description": "The category\'s ID.", "nullable": true}, "category_name": {"type": "string", "description": "The category\'s name.", "nullable": true}}}, "description": "The path from the category to its root category. The first node of the path is the parent of the category\nand the last is the root category. The path is empty if the category is a root category.", "nullable": true}}, "example": {"object": {"category_data": {"name": "Beverages"}, "id": "#Beverages", "present_at_all_locations": true, "type": "CATEGORY"}}}, "item_variation_data": {"type": "object", "description": "An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one\nitem variation and can have at most 250 item variations.\n\nAn item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked\nnumber of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both\nstockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass\nvariation is sellable, but not stockable. To accurately keep track of the wine\'s inventory count at any time, the sellable count must be\nconverted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes\nthe `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count\ndecreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.", "x-release-status": "PUBLIC", "properties": {"item_id": {"type": "string", "description": "The ID of the `CatalogItem` associated with this item variation.", "nullable": true}, "name": {"type": "string", "description": "The item variation\'s name. This is a searchable attribute for use in applicable query filters.\n\nIts value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem)\nuses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be\nlonger than 255 Unicode code points.", "nullable": true}, "sku": {"type": "string", "description": "The item variation\'s SKU, if any. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "upc": {"type": "string", "description": "The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters.\n\nThe value of this attribute should be a number of 12-14 digits long.  This restriction is enforced on the Square Seller Dashboard,\nSquare Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned\nto this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps\nunless it is updated to fit the expected format.", "nullable": true}, "ordinal": {"type": "integer", "description": "The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal\nfor each item variation within a parent `CatalogItem` is set according to the item variations\'s\nposition. On reads, the value is not guaranteed to be sequential or unique.", "readOnly": true}, "pricing_type": {"type": "string", "enum": ["FIXED_PRICING", "VARIABLE_PRICING"], "x-enum-elements": [{"name": "FIXED_PRICING", "description": "The catalog item variation\'s price is fixed."}, {"name": "VARIABLE_PRICING", "description": "The catalog item variation\'s price is entered at the time of sale."}], "description": "Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.", "x-release-status": "PUBLIC"}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "location_overrides": {"type": "array", "items": {"type": "object", "description": "Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.", "x-release-status": "PUBLIC", "properties": {"location_id": {"type": "string", "description": "The ID of the `Location`. This can include locations that are deactivated.", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_type": {"type": "string", "enum": ["FIXED_PRICING", "VARIABLE_PRICING"], "x-enum-elements": [{"name": "FIXED_PRICING", "description": "The catalog item variation\'s price is fixed."}, {"name": "VARIABLE_PRICING", "description": "The catalog item variation\'s price is entered at the time of sale."}], "description": "Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.", "x-release-status": "PUBLIC"}, "track_inventory": {"type": "boolean", "description": "If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`.", "nullable": true}, "inventory_alert_type": {"type": "string", "enum": ["NONE", "LOW_QUANTITY"], "x-enum-elements": [{"name": "NONE", "description": "The variation does not display an alert."}, {"name": "LOW_QUANTITY", "description": "The variation generates an alert when its quantity is low."}], "description": "Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.", "x-release-status": "PUBLIC"}, "inventory_alert_threshold": {"type": "integer", "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", "format": "int64", "nullable": true}, "sold_out": {"type": "boolean", "description": "Indicates whether the overridden item variation is sold out at the specified location.\n\nWhen inventory tracking is enabled on the item variation either globally or at the specified location,\nthe item variation is automatically marked as sold out when its inventory count reaches zero. The seller\ncan manually set the item variation as sold out even when the inventory count is greater than zero.\nAttempts by an application to set this attribute are ignored. Regardless how the sold-out status is set,\napplications should treat its inventory count as zero when this attribute value is `true`.", "readOnly": true}, "sold_out_valid_until": {"type": "string", "description": "The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation\nbecomes available again at the specified location. Attempts by an application to set this attribute are ignored.\nWhen the current time is later than this attribute value, the affected item variation is no longer sold out.", "readOnly": true}}}, "description": "Per-location price and inventory overrides.", "nullable": true}, "track_inventory": {"type": "boolean", "description": "If `true`, inventory tracking is active for the variation.", "nullable": true}, "inventory_alert_type": {"type": "string", "enum": ["NONE", "LOW_QUANTITY"], "x-enum-elements": [{"name": "NONE", "description": "The variation does not display an alert."}, {"name": "LOW_QUANTITY", "description": "The variation generates an alert when its quantity is low."}], "description": "Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.", "x-release-status": "PUBLIC"}, "inventory_alert_threshold": {"type": "integer", "description": "If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`\nis `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.\n\nThis value is always an integer.", "format": "int64", "nullable": true}, "user_data": {"type": "string", "description": "Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "service_duration": {"type": "integer", "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For\nexample, a 30 minute appointment would have the value `1800000`, which is equal to\n30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).", "format": "int64", "nullable": true}, "available_for_booking": {"type": "boolean", "description": "If the `CatalogItem` that owns this item variation is of type\n`APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.", "x-release-status": "BETA", "nullable": true}, "item_option_values": {"type": "array", "items": {"type": "object", "description": "A `CatalogItemOptionValue` links an item variation to an item option as\nan item option value. For example, a t-shirt item may offer a color option and\na size option. An item option value would represent each variation of t-shirt:\nFor example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium".", "x-release-status": "PUBLIC", "properties": {"item_option_id": {"type": "string", "description": "The unique id of an item option.", "nullable": true}, "item_option_value_id": {"type": "string", "description": "The unique id of the selected value for the item option.", "nullable": true}}}, "description": "List of item option values associated with this item variation. Listed\nin the same order as the item options of the parent item.", "nullable": true}, "measurement_unit_id": {"type": "string", "description": "ID of the \u2018CatalogMeasurementUnit\u2019 that is used to measure the quantity\nsold of this item variation. If left unset, the item will be sold in\nwhole quantities.", "nullable": true}, "sellable": {"type": "boolean", "description": "Whether this variation can be sold. The inventory count of a sellable variation indicates\nthe number of units available for sale. When a variation is both stockable and sellable,\nits sellable inventory count can be smaller than or equal to its stockable count.", "x-release-status": "BETA", "nullable": true}, "stockable": {"type": "boolean", "description": "Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE).\nWhen a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock\nand is not an indicator of the number of units of the variation that can be sold.", "x-release-status": "BETA", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogItemVariation` instance.\nThese images will be shown to customers in Square Online Store.", "nullable": true}, "team_member_ids": {"type": "array", "items": {"type": "string"}, "description": "Tokens of employees that can perform the service represented by this variation. Only valid for\nvariations of type `APPOINTMENTS_SERVICE`.", "x-release-status": "BETA", "nullable": true}, "stockable_conversion": {"type": "object", "description": "Represents the rule of conversion between a stockable [CatalogItemVariation](entity:CatalogItemVariation)\nand a non-stockable sell-by or receive-by `CatalogItemVariation` that\nshare the same underlying stock.", "x-release-status": "BETA", "required": ["stockable_item_variation_id", "stockable_quantity", "nonstockable_quantity"], "properties": {"stockable_item_variation_id": {"type": "string", "description": "References to the stockable [CatalogItemVariation](entity:CatalogItemVariation)\nfor this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`\ndefined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.\nThis immutable field must reference a stockable `CatalogItemVariation`\nthat shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.`", "minLength": 1}, "stockable_quantity": {"type": "string", "description": "The quantity of the stockable item variation (as identified by `stockable_item_variation_id`)\nequivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`)\nas defined by this stock conversion.  It accepts a decimal number in a string format that can take\nup to 10 digits before the decimal point and up to 5 digits after the decimal point.", "minLength": 1, "maxLength": 16}, "nonstockable_quantity": {"type": "string", "description": "The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation)\nin its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together\ndefine the conversion ratio between stockable item variation and the non-stockable item variation.\nIt accepts a decimal number in a string format that can take up to 10 digits before the decimal point\nand up to 5 digits after the decimal point.", "minLength": 1, "maxLength": 16}}}}}, "tax_data": {"type": "object", "description": "A tax applicable to an item.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The tax\'s name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "calculation_phase": {"type": "string", "enum": ["TAX_SUBTOTAL_PHASE", "TAX_TOTAL_PHASE"], "x-enum-elements": [{"name": "TAX_SUBTOTAL_PHASE", "description": "The fee is calculated based on the payment\'s subtotal."}, {"name": "TAX_TOTAL_PHASE", "description": "The fee is calculated based on the payment\'s total."}], "description": "When to calculate the taxes due on a cart.", "x-release-status": "PUBLIC"}, "inclusion_type": {"type": "string", "enum": ["ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the\nCatalogItemVariation price. For example, a $1.00 item with a 10% additive\ntax would have a total cost to the buyer of $1.10."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. The tax amount is included in the\nCatalogItemVariation price. For example, a $1.00 item with a 10% inclusive\ntax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of\nthat total being the cost of the item and $0.09 (9 cents) being tax."}], "description": "Whether to the tax amount should be additional to or included in the CatalogItem price.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax in decimal form, using a `\'.\'` as the decimal separator and without a `\'%\'` sign.\nA value of `7.5` corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.", "nullable": true}, "applies_to_custom_amounts": {"type": "boolean", "description": "If `true`, the fee applies to custom amounts entered into the Square Point of Sale\napp that are not associated with a particular `CatalogItem`.", "nullable": true}, "enabled": {"type": "boolean", "description": "A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).", "nullable": true}, "applies_to_product_set_id": {"type": "string", "description": "The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set.", "x-release-status": "BETA", "nullable": true}}, "example": {"object": {"id": "#SalesTax", "present_at_all_locations": true, "tax_data": {"calculation_phase": "TAX_SUBTOTAL_PHASE", "enabled": true, "fee_applies_to_custom_amounts": true, "inclusion_type": "ADDITIVE", "name": "Sales Tax", "percentage": "5.0"}, "type": "TAX"}}}, "discount_data": {"type": "object", "description": "A discount applicable to items.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "discount_type": {"type": "string", "enum": ["FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (e.g., 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed amount (e.g., $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage off the item price. The percentage will be specified at the time of sale."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount off the item price. The amount will be specified at the time of sale."}], "description": "How to apply a CatalogDiscount to a CatalogItem.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal\nseparator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type`\nis `VARIABLE_PERCENTAGE`.\n\nDo not use this field for amount-based or variable discounts.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pin_required": {"type": "boolean", "description": "Indicates whether a mobile staff member needs to enter their PIN to apply the\ndiscount to a payment in the Square Point of Sale app.", "nullable": true}, "label_color": {"type": "string", "description": "The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code.", "nullable": true}, "modify_tax_basis": {"type": "string", "enum": ["MODIFY_TAX_BASIS", "DO_NOT_MODIFY_TAX_BASIS"], "x-enum-elements": [{"name": "MODIFY_TAX_BASIS", "description": "Application of the discount will modify the tax basis."}, {"name": "DO_NOT_MODIFY_TAX_BASIS", "description": "Application of the discount will not modify the tax basis."}], "x-release-status": "PUBLIC"}, "maximum_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}, "example": {"object": {"discount_data": {"discount_type": "FIXED_PERCENTAGE", "label_color": "red", "name": "Welcome to the Dark(Roast) Side!", "percentage": "5.4", "pin_required": false}, "id": "#Maythe4th", "present_at_all_locations": true, "type": "DISCOUNT"}}}, "modifier_list_data": {"type": "object", "description": "A container for a list of modifiers, or a text-based modifier.\nFor text-based modifiers, this represents text configuration for an item. (For example, custom text to print on a t-shirt).\nFor non text-based modifiers, this represents a list of modifiers that can be applied to items at the time of sale.\n(For example, a list of condiments for a hot dog, or a list of ice cream flavors).\nEach element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name of the `CatalogModifierList` instance. This is a searchable attribute for use in applicable query filters, and its value length is of \nUnicode code points.", "maxLength": 255, "nullable": true}, "ordinal": {"type": "integer", "description": "The position of this `CatalogModifierList` within a list of `CatalogModifierList` instances.", "nullable": true}, "selection_type": {"type": "string", "enum": ["SINGLE", "MULTIPLE"], "x-enum-elements": [{"name": "SINGLE", "description": "Indicates that a CatalogModifierList allows only a\nsingle CatalogModifier to be selected."}, {"name": "MULTIPLE", "description": "Indicates that a CatalogModifierList allows multiple\nCatalogModifier to be selected."}], "description": "Indicates whether a CatalogModifierList supports multiple selections.", "x-release-status": "PUBLIC"}, "modifiers": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A non-empty list of `CatalogModifier` objects to be included in the `CatalogModifierList`, \nfor non text-based modifiers when the `modifier_type` attribute is `LIST`. Each element of this list \nis a `CatalogObject` instance of the `MODIFIER` type, containing the following attributes:\n```\n{\n"id": "{{catalog_modifier_id}}",\n"type": "MODIFIER", \n"modifier_data": {{a CatalogModifier instance>}} \n}\n```", "nullable": true}, "image_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of images associated with this `CatalogModifierList` instance.\nCurrently these images are not displayed on Square products, but may be displayed in 3rd-party applications.", "nullable": true}, "allow_quantities": {"type": "boolean", "description": "When `true`, allows multiple quantities of the same modifier to be selected.", "x-release-status": "BETA", "nullable": true}, "is_conversational": {"type": "boolean", "description": "True if modifiers belonging to this list can be used conversationally.", "x-release-status": "BETA", "nullable": true}, "modifier_type": {"type": "string", "enum": ["LIST", "TEXT"], "x-enum-elements": [{"name": "LIST", "description": "The `CatalogModifierList` instance is a non-empty list of non text-based modifiers."}, {"name": "TEXT", "description": "The `CatalogModifierList` instance is a single text-based modifier."}], "description": "Defines the type of `CatalogModifierList`.", "x-release-status": "BETA"}, "max_length": {"type": "integer", "description": "The maximum length, in Unicode points, of the text string of the text-based modifier as represented by \nthis `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", "x-release-status": "BETA", "nullable": true}, "text_required": {"type": "boolean", "description": "Whether the text string must be a non-empty string (`true`) or not (`false`) for a text-based modifier\nas represented by this `CatalogModifierList` object with the `modifier_type` set to `TEXT`.", "x-release-status": "BETA", "nullable": true}, "internal_name": {"type": "string", "description": "A note for internal use by the business.   \n\nFor example, for a text-based modifier applied to a T-shirt item, if the buyer-supplied text of "Hello, Kitty!"  \nis to be printed on the T-shirt, this `internal_name` attribute can be "Use italic face" as \nan instruction for the business to follow.  \n\nFor non text-based modifiers, this `internal_name` attribute can be \nused to include SKUs, internal codes, or supplemental descriptions for internal use.", "maxLength": 512, "x-release-status": "BETA", "nullable": true}, "min_selected_modifiers": {"type": "integer", "description": "The minimum number of modifiers that must be selected from this list. The value can be overridden with `CatalogItemModifierListInfo`.\n\nValues:\n\n- 0: No selection is required.\n- -1: Default value, the attribute was not set by the client. Treated as no selection required.\n- &gt;0: The required minimum modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no selection required.", "format": "int64", "x-release-status": "BETA", "nullable": true}, "max_selected_modifiers": {"type": "integer", "description": "The maximum number of modifiers that must be selected from this list. The value can be overridden with `CatalogItemModifierListInfo`.\n\nValues:\n\n- 0: No maximum limit.\n- -1: Default value, the attribute was not set by the client. Treated as no maximum limit.\n- &gt;0: The maximum total modifier selections. This can be larger than the total `CatalogModifiers` when `allow_quantities` is enabled.\n- &lt; -1: Invalid. Treated as no maximum limit.", "format": "int64", "x-release-status": "BETA", "nullable": true}, "hidden_from_customer": {"type": "boolean", "description": "If `true`, modifiers from this list are hidden from customer receipts. The default value is `false`.\nThis setting can be overridden with `CatalogItemModifierListInfo.hidden_from_customer_override`.", "x-release-status": "BETA", "nullable": true}}, "example": {"id": "#MilkType", "modifier_list_data": {"allow_quantities": false, "modifiers": [{"modifier_data": {"name": "Whole Milk", "price_money": {"amount": 0, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}, {"modifier_data": {"name": "Almond Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}, {"modifier_data": {"name": "Soy Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}], "name": "Milk Type", "selection_type": "SINGLE"}, "present_at_all_locations": true, "type": "MODIFIER_LIST"}}, "modifier_data": {"type": "object", "description": "A modifier that can be applied to items at the time of sale. For example, a cheese modifier for a burger, or a flavor modifier for a serving of ice cream.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The modifier name.  This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.", "maxLength": 255, "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "on_by_default": {"type": "boolean", "description": "When `true`, this modifier is selected by default when displaying the modifier list.\nThis setting can be overridden at the item level using `CatalogModifierListInfo.modifier_overrides`.", "x-release-status": "BETA", "nullable": true}, "ordinal": {"type": "integer", "description": "Determines where this `CatalogModifier` appears in the `CatalogModifierList`.", "nullable": true}, "modifier_list_id": {"type": "string", "description": "The ID of the `CatalogModifierList` associated with this modifier.", "nullable": true}, "location_overrides": {"type": "array", "items": {"type": "object", "description": "Location-specific overrides for specified properties of a `CatalogModifier` object.", "x-release-status": "PUBLIC", "properties": {"location_id": {"type": "string", "description": "The ID of the `Location` object representing the location. This can include a deactivated location.", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "sold_out": {"type": "boolean", "description": "Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out.\nThe seller can manually set this sold out status. Attempts by an application to set this attribute are ignored.", "readOnly": true}}}, "description": "Location-specific price overrides.", "nullable": true}, "image_id": {"type": "string", "description": "The ID of the image associated with this `CatalogModifier` instance.\nCurrently this image is not displayed by Square, but is free to be displayed in 3rd party applications.", "x-release-status": "BETA", "nullable": true}, "hidden_online": {"type": "boolean", "description": "When `true`, this modifier is hidden from online ordering channels. This setting can be overridden at the item level using `CatalogModifierListInfo.modifier_overrides`.", "x-release-status": "BETA", "nullable": true}}, "example": {"object": {"modifier_data": {"name": "Almond Milk", "price_money": {"amount": 250, "currency": "USD"}}, "present_at_all_locations": true, "type": "MODIFIER"}}}, "time_period_data": {"type": "object", "description": "Represents a time period - either a single period or a repeating period.", "x-release-status": "PUBLIC", "properties": {"event": {"type": "string", "description": "An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which\nspecifies the name, timing, duration and recurrence of this time period.\n\nExample:\n\n```\nDTSTART:20190707T180000\nDURATION:P2H\nRRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR\n```\n\nOnly `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported.\n`DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT`\nand `END:VEVENT` is not required in the request. The response will always\ninclude them.", "nullable": true}}}, "product_set_data": {"type": "object", "description": "Represents a collection of catalog objects for the purpose of applying a\n`PricingRule`. Including a catalog object will include all of its subtypes.\nFor example, including a category in a product set will include all of its\nitems and associated item variations in the product set. Including an item in\na product set will also include its item variations.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "User-defined name for the product set. For example, "Clearance Items"\nor "Winter Sale Items".", "nullable": true}, "product_ids_any": {"type": "array", "items": {"type": "string"}, "description": " Unique IDs for any `CatalogObject` included in this product set. Any\nnumber of these catalog objects can be in an order for a pricing rule to apply.\n\nThis can be used with `product_ids_all` in a parent `CatalogProductSet` to\nmatch groups of products for a bulk discount, such as a discount for an\nentree and side combo.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", "nullable": true}, "product_ids_all": {"type": "array", "items": {"type": "string"}, "description": "Unique IDs for any `CatalogObject` included in this product set.\nAll objects in this set must be included in an order for a pricing rule to apply.\n\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.\n\nMax: 500 catalog object IDs.", "nullable": true}, "quantity_exact": {"type": "integer", "description": "If set, there must be exactly this many items from `products_any` or `products_all`\nin the cart for the discount to apply.\n\nCannot be combined with either `quantity_min` or `quantity_max`.", "format": "int64", "nullable": true}, "quantity_min": {"type": "integer", "description": "If set, there must be at least this many items from `products_any` or `products_all`\nin a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if\n`quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.", "format": "int64", "nullable": true}, "quantity_max": {"type": "integer", "description": "If set, the pricing rule will apply to a maximum of this many items from\n`products_any` or `products_all`.", "format": "int64", "nullable": true}, "all_products": {"type": "boolean", "description": "If set to `true`, the product set will include every item in the catalog.\nOnly one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.", "nullable": true}}}, "pricing_rule_data": {"type": "object", "description": "Defines how discounts are automatically applied to a set of items that match the pricing rule\nduring the active time period.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "User-defined name for the pricing rule. For example, "Buy one get one\nfree" or "10% off".", "nullable": true}, "time_period_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of unique IDs for the catalog time periods when\nthis pricing rule is in effect. If left unset, the pricing rule is always\nin effect.", "nullable": true}, "discount_id": {"type": "string", "description": "Unique ID for the `CatalogDiscount` to take off\nthe price of all matched items.", "nullable": true}, "match_products_id": {"type": "string", "description": "Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule\nmatches within the entire cart, and can match multiple times. This field will always be set.", "nullable": true}, "apply_products_id": {"type": "string", "description": "__Deprecated__: Please use the `exclude_products_id` field to apply\nan exclude set instead. Exclude sets allow better control over quantity\nranges and offer more flexibility for which matched items receive a discount.\n\n`CatalogProductSet` to apply the pricing to.\nAn apply rule matches within the subset of the cart that fits the match rules (the match set).\nAn apply rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", "x-release-status": "DEPRECATED", "nullable": true}, "exclude_products_id": {"type": "string", "description": "`CatalogProductSet` to exclude from the pricing rule.\nAn exclude rule matches within the subset of the cart that fits the match rules (the match set).\nAn exclude rule can only match once in the match set.\nIf not supplied, the pricing will be applied to all products in the match set.\nOther products retain their base price, or a price generated by other rules.", "nullable": true}, "valid_from_date": {"type": "string", "description": "Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD).", "nullable": true}, "valid_from_local_time": {"type": "string", "description": "Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", "nullable": true}, "valid_until_date": {"type": "string", "description": "Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD).", "nullable": true}, "valid_until_local_time": {"type": "string", "description": "Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format\n(HH:MM:SS). Partial seconds will be truncated.", "nullable": true}, "exclude_strategy": {"type": "string", "enum": ["LEAST_EXPENSIVE", "MOST_EXPENSIVE"], "x-enum-elements": [{"name": "LEAST_EXPENSIVE", "description": "The least expensive matched products are excluded from the pricing. If\nthe pricing rule is set to exclude one product and multiple products in the\nmatch set qualify as least expensive, then one will be excluded at random.\n\nExcluding the least expensive product gives the best discount value to the buyer."}, {"name": "MOST_EXPENSIVE", "description": "The most expensive matched product is excluded from the pricing rule.\nIf multiple products have the same price and all qualify as least expensive,\none will be excluded at random.\n\nThis guarantees that the most expensive product is purchased at full price."}], "description": "Indicates which products matched by a CatalogPricingRule\nwill be excluded if the pricing rule uses an exclude set.", "x-release-status": "BETA"}, "minimum_order_subtotal_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_group_ids_any": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule.\nNotice that a group ID is generated by the Customers API.\nIf this field is not set, the specified discount applies to matched products sold to anyone whether the buyer\nhas a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount\napplies only to matched products sold to customers belonging to the specified customer groups.", "nullable": true}}}, "image_data": {"type": "object", "description": "An image file to use in Square catalogs. It can be associated with\n`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects.\nOnly the images on items and item variations are exposed in Dashboard.\nOnly the first image on an item is displayed in Square Point of Sale (SPOS).\nImages on items and variations are displayed through Square Online Store.\nImages on other object types are for use by 3rd party application developers.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The internal name to identify this image in calls to the Square API.\nThis is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).\nIt is not unique and should not be shown in a buyer facing context.", "nullable": true}, "url": {"type": "string", "description": "The URL of this image, generated by Square after an image is uploaded\nusing the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint.\nTo modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.", "nullable": true}, "caption": {"type": "string", "description": "A caption that describes what is shown in the image. Displayed in the\nSquare Online Store. This is a searchable attribute for use in applicable query filters\nusing the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).", "nullable": true}, "photo_studio_order_id": {"type": "string", "description": "The immutable order ID for this image object created by the Photo Studio service in Square Online Store.", "nullable": true}}}, "measurement_unit_data": {"type": "object", "description": "Represents the unit used to measure a `CatalogItemVariation` and\nspecifies the precision for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in quantities measured with this unit.\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 3", "nullable": true}}}, "subscription_plan_data": {"type": "object", "description": "Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["name"], "properties": {"name": {"type": "string", "description": "The name of the plan."}, "phases": {"type": "array", "items": {"type": "object", "description": "Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["cadence"], "properties": {"uid": {"type": "string", "description": "The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "cadence": {"type": "string", "enum": ["DAILY", "WEEKLY", "EVERY_TWO_WEEKS", "THIRTY_DAYS", "SIXTY_DAYS", "NINETY_DAYS", "MONTHLY", "EVERY_TWO_MONTHS", "QUARTERLY", "EVERY_FOUR_MONTHS", "EVERY_SIX_MONTHS", "ANNUAL", "EVERY_TWO_YEARS"], "x-enum-elements": [{"name": "DAILY", "description": "Once per day"}, {"name": "WEEKLY", "description": "Once per week"}, {"name": "EVERY_TWO_WEEKS", "description": "Every two weeks"}, {"name": "THIRTY_DAYS", "description": "Once every 30 days"}, {"name": "SIXTY_DAYS", "description": "Once every 60 days"}, {"name": "NINETY_DAYS", "description": "Once every 90 days"}, {"name": "MONTHLY", "description": "Once per month"}, {"name": "EVERY_TWO_MONTHS", "description": "Once every two months"}, {"name": "QUARTERLY", "description": "Once every three months"}, {"name": "EVERY_FOUR_MONTHS", "description": "Once every four months"}, {"name": "EVERY_SIX_MONTHS", "description": "Once every six months"}, {"name": "ANNUAL", "description": "Once per year"}, {"name": "EVERY_TWO_YEARS", "description": "Once every two years"}], "description": "Determines the billing cadence of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "periods": {"type": "integer", "description": "The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "recurring_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ordinal": {"type": "integer", "description": "The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.", "format": "int64", "nullable": true}, "pricing": {"type": "object", "description": "Describes the pricing for the subscription.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STATIC", "RELATIVE"], "x-enum-elements": [{"name": "STATIC", "description": "Static pricing"}, {"name": "RELATIVE", "description": "Relative pricing"}], "description": "Determines the pricing of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "discount_ids": {"type": "array", "items": {"type": "string"}, "description": "The ids of the discount catalog objects", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan.\nThis field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error", "nullable": true}, "subscription_plan_variations": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "The list of subscription plan variations available for this product", "nullable": true}, "eligible_item_ids": {"type": "array", "items": {"type": "string"}, "description": "The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan\'s variations.", "nullable": true}, "eligible_category_ids": {"type": "array", "items": {"type": "string"}, "description": "The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan\'s variations.", "nullable": true}, "all_items": {"type": "boolean", "description": "If true, all items in the merchant\'s catalog are subscribable by this SubscriptionPlan.", "nullable": true}}}, "item_option_data": {"type": "object", "description": "A group of variations for a `CatalogItem`.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The item option\'s display name for the seller. Must be unique across\nall item options. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "display_name": {"type": "string", "description": "The item option\'s display name for the customer. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "description": {"type": "string", "description": "The item option\'s human-readable description. Displayed in the Square\nPoint of Sale app for the seller and in the Online Store or on receipts for\nthe buyer. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "show_colors": {"type": "boolean", "description": "If true, display colors for entries in `values` when present.", "nullable": true}, "values": {"type": "array", "items": {"$ref": "#/components/schemas/CatalogObject", "has_circular_reference": true}, "description": "A list of CatalogObjects containing the\n`CatalogItemOptionValue`s for this item.", "nullable": true}}}, "item_option_value_data": {"type": "object", "description": "An enumerated value that can link a\n`CatalogItemVariation` to an item option as one of\nits item option values.", "x-release-status": "PUBLIC", "properties": {"item_option_id": {"type": "string", "description": "Unique ID of the associated item option.", "nullable": true}, "name": {"type": "string", "description": "Name of this item option value. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "description": {"type": "string", "description": "A human-readable description for the option value. This is a searchable attribute for use in applicable query filters.", "nullable": true}, "color": {"type": "string", "description": "The HTML-supported hex color for the item option (e.g., "#ff8d4e85").\nOnly displayed if `show_colors` is enabled on the parent `ItemOption`. When\nleft unset, `color` defaults to white ("#ffffff") when `show_colors` is\nenabled on the parent `ItemOption`.", "nullable": true}, "ordinal": {"type": "integer", "description": "Determines where this option value appears in a list of option values.", "nullable": true}}}, "custom_attribute_definition_data": {"type": "object", "description": "Contains information defining a custom attribute. Custom attributes are\nintended to store additional information about a catalog object or to associate a\ncatalog object with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)", "x-release-status": "PUBLIC", "required": ["type", "name", "allowed_object_types"], "properties": {"type": {"type": "string", "enum": ["STRING", "BOOLEAN", "NUMBER", "SELECTION"], "x-enum-elements": [{"name": "STRING", "description": "A free-form string containing up to 255 characters."}, {"name": "BOOLEAN", "description": "A `true` or `false` value."}, {"name": "NUMBER", "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point."}, {"name": "SELECTION", "description": "One or more choices from `allowed_selections`."}], "description": "Defines the possible types for a custom attribute.", "x-release-status": "PUBLIC"}, "name": {"type": "string", "description": " The name of this definition for API and seller-facing UI purposes.\nThe name must be unique within the (merchant, application) pair. Required.\nMay not be empty and may not exceed 255 characters. Can be modified after creation.", "minLength": 1, "maxLength": 255}, "description": {"type": "string", "description": "Seller-oriented description of the meaning of this Custom Attribute,\nany constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.", "maxLength": 255, "nullable": true}, "source_application": {"type": "object", "description": "Represents information about the application used to generate a change.", "x-release-status": "PUBLIC", "properties": {"product": {"type": "string", "enum": ["SQUARE_POS", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "DASHBOARD", "ITEM_LIBRARY_IMPORT", "OTHER"], "x-enum-elements": [{"name": "SQUARE_POS", "description": "Square Point of Sale application."}, {"name": "EXTERNAL_API", "description": "Square Connect APIs (for example, Orders API or Checkout API)."}, {"name": "BILLING", "description": "A Square subscription (various products)."}, {"name": "APPOINTMENTS", "description": "Square Appointments."}, {"name": "INVOICES", "description": "Square Invoices."}, {"name": "ONLINE_STORE", "description": "Square Online Store."}, {"name": "PAYROLL", "description": "Square Payroll."}, {"name": "DASHBOARD", "description": "Square Dashboard."}, {"name": "ITEM_LIBRARY_IMPORT", "description": "Item Library Import."}, {"name": "OTHER", "description": "A Square product that does not match any other value."}], "description": "Indicates the Square product used to generate a change.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", "nullable": true}, "name": {"type": "string", "description": "__Read only__ The display name of the application\n(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).", "nullable": true}}}, "allowed_object_types": {"type": "array", "items": {"type": "string", "enum": ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER", "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD", "MEASUREMENT_UNIT", "SUBSCRIPTION_PLAN_VARIATION", "ITEM_OPTION", "ITEM_OPTION_VAL", "CUSTOM_ATTRIBUTE_DEFINITION", "QUICK_AMOUNTS_SETTINGS", "SUBSCRIPTION_PLAN", "AVAILABILITY_PERIOD"], "x-enum-elements": [{"name": "ITEM", "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field."}, {"name": "IMAGE", "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field."}, {"name": "CATEGORY", "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field."}, {"name": "ITEM_VARIATION", "description": "The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field."}, {"name": "TAX", "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field."}, {"name": "DISCOUNT", "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field."}, {"name": "MODIFIER_LIST", "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field."}, {"name": "MODIFIER", "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field."}, {"name": "PRICING_RULE", "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field."}, {"name": "PRODUCT_SET", "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field."}, {"name": "TIME_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field."}, {"name": "MEASUREMENT_UNIT", "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field."}, {"name": "SUBSCRIPTION_PLAN_VARIATION", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field."}, {"name": "ITEM_OPTION", "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field."}, {"name": "ITEM_OPTION_VAL", "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of "Size" may have item option values such as "Small" or "Medium".\nThe item-option-value-specific data must be on the `item_option_value_data` field."}, {"name": "CUSTOM_ATTRIBUTE_DEFINITION", "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field."}, {"name": "QUICK_AMOUNTS_SETTINGS", "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field."}, {"name": "SUBSCRIPTION_PLAN", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field."}, {"name": "AVAILABILITY_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field."}], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", "x-release-status": "PUBLIC"}, "description": "The set of `CatalogObject` types that this custom atttribute may be applied to.\nCurrently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included.\nSee [CatalogObjectType](#type-catalogobjecttype) for possible values"}, "seller_visibility": {"type": "string", "enum": ["SELLER_VISIBILITY_HIDDEN", "SELLER_VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "SELLER_VISIBILITY_HIDDEN", "description": "Sellers cannot read this custom attribute in Square client\napplications or Square APIs."}, {"name": "SELLER_VISIBILITY_READ_WRITE_VALUES", "description": "Sellers can read and write this custom attribute value in catalog objects,\nbut cannot edit the custom attribute definition."}], "description": "Defines the visibility of a custom attribute to sellers in Square\nclient applications, Square APIs or in Square UIs (including Square Point\nof Sale applications and Square Dashboard).", "x-release-status": "PUBLIC"}, "app_visibility": {"type": "string", "enum": ["APP_VISIBILITY_HIDDEN", "APP_VISIBILITY_READ_ONLY", "APP_VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "APP_VISIBILITY_HIDDEN", "description": "Other applications cannot read this custom attribute."}, {"name": "APP_VISIBILITY_READ_ONLY", "description": "Other applications can read this custom attribute definition and\nvalues."}, {"name": "APP_VISIBILITY_READ_WRITE_VALUES", "description": "Other applications can read and write custom attribute values on objects.\nThey can read but cannot edit the custom attribute definition."}], "description": "Defines the visibility of a custom attribute to applications other than their\ncreating application.", "x-release-status": "PUBLIC"}, "string_config": {"type": "object", "description": "Configuration associated with Custom Attribute Definitions of type `STRING`.", "x-release-status": "PUBLIC", "properties": {"enforce_uniqueness": {"type": "boolean", "description": "If true, each Custom Attribute instance associated with this Custom Attribute\nDefinition must have a unique value within the seller\'s catalog. For\nexample, this may be used for a value like a SKU that should not be\nduplicated within a seller\'s catalog. May not be modified after the\ndefinition has been created.", "nullable": true}}}, "number_config": {"type": "object", "x-release-status": "PUBLIC", "properties": {"precision": {"type": "integer", "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in number custom attribute values\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 5", "maximum": 5, "nullable": true}}}, "selection_config": {"type": "object", "description": "Configuration associated with `SELECTION`-type custom attribute definitions.", "x-release-status": "PUBLIC", "properties": {"max_allowed_selections": {"type": "integer", "description": "The maximum number of selections that can be set. The maximum value for this\nattribute is 100. The default value is 1. The value can be modified, but changing the value will not\naffect existing custom attribute values on objects. Clients need to\nhandle custom attributes with more selected values than allowed by this limit.", "maximum": 100, "nullable": true}, "allowed_selections": {"type": "array", "items": {"type": "object", "description": "A named selection for this `SELECTION`-type custom attribute definition.", "x-release-status": "PUBLIC", "required": ["name"], "properties": {"uid": {"type": "string", "description": "Unique ID set by Square.", "nullable": true}, "name": {"type": "string", "description": "Selection name, unique within `allowed_selections`.", "minLength": 1, "maxLength": 255}}}, "description": "The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100\nselections can be defined. Can be modified.", "nullable": true}}}, "custom_attribute_usage_count": {"type": "integer", "description": "The number of custom attributes that reference this\ncustom attribute definition. Set by the server in response to a ListCatalog\nrequest with `include_counts` set to `true`.  If the actual count is greater\nthan 100, `custom_attribute_usage_count` will be set to `100`.", "readOnly": true}, "key": {"type": "string", "description": "The name of the desired custom attribute key that can be used to access\nthe custom attribute value on catalog objects. Cannot be modified after the\ncustom attribute definition has been created.\nMust be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.", "minLength": 1, "maxLength": 60, "pattern": "^[a-zA-Z0-9_-]*$", "nullable": true}}}, "quick_amounts_settings_data": {"type": "object", "description": "A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.", "x-release-status": "BETA", "required": ["option"], "properties": {"option": {"type": "string", "enum": ["DISABLED", "MANUAL", "AUTO"], "x-enum-elements": [{"name": "DISABLED", "description": "Option for seller to disable Quick Amounts."}, {"name": "MANUAL", "description": "Option for seller to choose manually created Quick Amounts."}, {"name": "AUTO", "description": "Option for seller to choose automatically created Quick Amounts."}], "description": "Determines a seller\'s option on Quick Amounts feature.", "x-release-status": "BETA"}, "eligible_for_auto_amounts": {"type": "boolean", "description": "Represents location\'s eligibility for auto amounts\nThe boolean should be consistent with whether there are AUTO amounts in the `amounts`.", "nullable": true}, "amounts": {"type": "array", "items": {"type": "object", "description": "Represents a Quick Amount in the Catalog.", "x-release-status": "BETA", "required": ["type", "amount"], "properties": {"type": {"type": "string", "enum": ["QUICK_AMOUNT_TYPE_MANUAL", "QUICK_AMOUNT_TYPE_AUTO"], "x-enum-elements": [{"name": "QUICK_AMOUNT_TYPE_MANUAL", "description": "Quick Amount is created manually by the seller."}, {"name": "QUICK_AMOUNT_TYPE_AUTO", "description": "Quick Amount is generated automatically by machine learning algorithms."}], "description": "Determines the type of a specific Quick Amount.", "x-release-status": "BETA"}, "amount": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "score": {"type": "integer", "description": "Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].\nMANUAL type amount will always have score = 100.", "format": "int64", "nullable": true}, "ordinal": {"type": "integer", "description": "The order in which this Quick Amount should be displayed.", "format": "int64", "nullable": true}}}, "description": "Represents a set of Quick Amounts at this location.", "nullable": true}}}, "subscription_plan_variation_data": {"type": "object", "description": "Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold.\nFor more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["name", "phases"], "properties": {"name": {"type": "string", "description": "The name of the plan variation."}, "phases": {"type": "array", "items": {"type": "object", "description": "Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).", "x-release-status": "PUBLIC", "required": ["cadence"], "properties": {"uid": {"type": "string", "description": "The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "cadence": {"type": "string", "enum": ["DAILY", "WEEKLY", "EVERY_TWO_WEEKS", "THIRTY_DAYS", "SIXTY_DAYS", "NINETY_DAYS", "MONTHLY", "EVERY_TWO_MONTHS", "QUARTERLY", "EVERY_FOUR_MONTHS", "EVERY_SIX_MONTHS", "ANNUAL", "EVERY_TWO_YEARS"], "x-enum-elements": [{"name": "DAILY", "description": "Once per day"}, {"name": "WEEKLY", "description": "Once per week"}, {"name": "EVERY_TWO_WEEKS", "description": "Every two weeks"}, {"name": "THIRTY_DAYS", "description": "Once every 30 days"}, {"name": "SIXTY_DAYS", "description": "Once every 60 days"}, {"name": "NINETY_DAYS", "description": "Once every 90 days"}, {"name": "MONTHLY", "description": "Once per month"}, {"name": "EVERY_TWO_MONTHS", "description": "Once every two months"}, {"name": "QUARTERLY", "description": "Once every three months"}, {"name": "EVERY_FOUR_MONTHS", "description": "Once every four months"}, {"name": "EVERY_SIX_MONTHS", "description": "Once every six months"}, {"name": "ANNUAL", "description": "Once per year"}, {"name": "EVERY_TWO_YEARS", "description": "Once every two years"}], "description": "Determines the billing cadence of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "periods": {"type": "integer", "description": "The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.", "nullable": true}, "recurring_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ordinal": {"type": "integer", "description": "The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.", "format": "int64", "nullable": true}, "pricing": {"type": "object", "description": "Describes the pricing for the subscription.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["STATIC", "RELATIVE"], "x-enum-elements": [{"name": "STATIC", "description": "Static pricing"}, {"name": "RELATIVE", "description": "Relative pricing"}], "description": "Determines the pricing of a [Subscription](entity:Subscription)", "x-release-status": "PUBLIC"}, "discount_ids": {"type": "array", "items": {"type": "string"}, "description": "The ids of the discount catalog objects", "nullable": true}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation."}, "subscription_plan_id": {"type": "string", "description": "The id of the subscription plan, if there is one.", "nullable": true}, "monthly_billing_anchor_date": {"type": "integer", "description": "The day of the month the billing period starts.", "format": "int64", "minimum": 1, "maximum": 31, "nullable": true}, "can_prorate": {"type": "boolean", "description": "Whether bills for this plan variation can be split for proration.", "nullable": true}, "successor_plan_variation_id": {"type": "string", "description": "The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all\nlocations, it indicates that this variation is deprecated and the object identified by the successor ID be used in\nits stead.", "nullable": true}}}, "availability_period_data": {"type": "object", "description": "Represents a time period of availability.", "x-release-status": "BETA", "properties": {"start_local_time": {"type": "string", "description": "The start time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "end_local_time": {"type": "string", "description": "The end time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "day_of_week": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"], "x-enum-elements": [{"name": "SUN", "description": "Sunday"}, {"name": "MON", "description": "Monday"}, {"name": "TUE", "description": "Tuesday"}, {"name": "WED", "description": "Wednesday"}, {"name": "THU", "description": "Thursday"}, {"name": "FRI", "description": "Friday"}, {"name": "SAT", "description": "Saturday"}], "description": "Indicates the specific day  of the week.", "x-release-status": "PUBLIC"}}}}, "example": {"catalog_object": {"absent_at_location_ids": ["{{ LOCATIONID-1 }}", "{{ LOCATIONID-N }}"], "category_data": "{{ CatalogCategory object only if type=CATEGORY }}", "connect_v1_ids": {"catalog_v1_id": "{{ itemID from Catalog v1 }}", "location_id": "{{ location where v1 ID is used }}"}, "discount_data": "{{ CatalogDiscount object only if type=DISCOUNT }}", "id": "{{ set by Catalog during object creation }}", "is_deleted": "{{ [true | false] }}", "item_data": "{{ CatalogItem object only if type=ITEM }}", "item_variation_data": "{{ CatalogItemVariation object only if type=ITEM_VARIATION }}", "modifier_data": "{{ CatalogModifier object only if type=MODIFIER }}", "modifier_list_data": "{{ CatalogModifierList object only if type=MODIFIER_LIST }}", "present_at_all_locations": "{{ [true | false] }}", "present_at_location_ids": ["{{ LOCATIONID-1 }}", "{{ LOCATIONID-N }}"], "tax_data": "{{ CatalogTax object only if type=TAX }}", "type": "{{ [ITEM | ITEM_VARIATION | MODIFIER | MODIFIER_LIST | CATEGORY | DISCOUNT | TAX] }}", "updated_at": "{{ date & time of most recent update }}", "version": "{{ version of the CatalogObject }}"}}}}, "example": {"idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae", "object": {"id": "#Cocoa", "item_data": {"abbreviation": "Ch", "description_html": "<p><strong>Hot</strong> Chocolate</p>", "name": "Cocoa", "variations": [{"id": "#Small", "item_variation_data": {"item_id": "#Cocoa", "name": "Small", "pricing_type": "VARIABLE_PRICING"}, "type": "ITEM_VARIATION"}, {"id": "#Large", "item_variation_data": {"item_id": "#Cocoa", "name": "Large", "price_money": {"amount": 400, "currency": "USD"}, "pricing_type": "FIXED_PRICING"}, "type": "ITEM_VARIATION"}]}, "type": "ITEM"}}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.csharp", "java": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.java", "javascript": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.javascript", "php": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.php", "python": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.python", "ruby": "/sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.ruby"}}',  # noqa: E501
    "SEARCHCATALOGOBJECTS": '{"type": "object", "x-release-status": "PUBLIC", "properties": {"cursor": {"type": "string", "description": "The pagination cursor returned in the previous response. Leave unset for an initial request.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."}, "object_types": {"type": "array", "items": {"type": "string", "enum": ["ITEM", "IMAGE", "CATEGORY", "ITEM_VARIATION", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER", "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD", "MEASUREMENT_UNIT", "SUBSCRIPTION_PLAN_VARIATION", "ITEM_OPTION", "ITEM_OPTION_VAL", "CUSTOM_ATTRIBUTE_DEFINITION", "QUICK_AMOUNTS_SETTINGS", "SUBSCRIPTION_PLAN", "AVAILABILITY_PERIOD"], "x-enum-elements": [{"name": "ITEM", "description": "The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data\nmust be set on the `item_data` field."}, {"name": "IMAGE", "description": "The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data\nmust be set on the `image_data` field."}, {"name": "CATEGORY", "description": "The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data\nmust be set on the `category_data` field."}, {"name": "ITEM_VARIATION", "description": "The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.\nThe item variation-specific data must be set on the `item_variation_data` field."}, {"name": "TAX", "description": "The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data\nmust be set on the `tax_data` field."}, {"name": "DISCOUNT", "description": "The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data\nmust be set on the `discount_data` field."}, {"name": "MODIFIER_LIST", "description": "The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.\nThe modifier-list-specific data must be set on the `modifier_list_data` field."}, {"name": "MODIFIER", "description": "The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data\nmust be set on the `modifier_data` field."}, {"name": "PRICING_RULE", "description": "The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data\nmust be set on the `pricing_rule_data` field."}, {"name": "PRODUCT_SET", "description": "The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.\nThe product-set-specific data will be stored in the `product_set_data` field."}, {"name": "TIME_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.\nThe time-period-specific data must be set on the `time_period_data` field."}, {"name": "MEASUREMENT_UNIT", "description": "The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of\nmeasure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field."}, {"name": "SUBSCRIPTION_PLAN_VARIATION", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription-plan-specific data must be stored on the `subscription_plan_data` field."}, {"name": "ITEM_OPTION", "description": "The `CatalogObject` instance is of the [CatalogItemOption](entity:CatalogItemOption) type and represents a list of options (such as a color or size of a T-shirt)\nthat can be assigned to item variations. The item-option-specific data must be on the `item_option_data` field."}, {"name": "ITEM_OPTION_VAL", "description": "The `CatalogObject` instance is of the [CatalogItemOptionValue](entity:CatalogItemOptionValue) type and represents a value associated with one or more item options.\nFor example, an item option of "Size" may have item option values such as "Small" or "Medium".\nThe item-option-value-specific data must be on the `item_option_value_data` field."}, {"name": "CUSTOM_ATTRIBUTE_DEFINITION", "description": "The `CatalogObject` instance is of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) type and represents the definition of a custom attribute.\nThe custom-attribute-definition-specific data must be set on the `custom_attribute_definition_data` field."}, {"name": "QUICK_AMOUNTS_SETTINGS", "description": "The `CatalogObject` instance is of the [CatalogQuickAmountsSettings](entity:CatalogQuickAmountsSettings) type and represents settings to configure preset charges for quick payments at each location.\nFor example, a location may have a list of both AUTO and MANUAL quick amounts that are set to DISABLED.\nThe quick-amounts-settings-specific data must be set on the `quick_amounts_settings_data` field."}, {"name": "SUBSCRIPTION_PLAN", "description": "The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.\nThe subscription plan specific data must be stored on the `subscription_plan_data` field."}, {"name": "AVAILABILITY_PERIOD", "description": "The `CatalogObject` instance is of the [CatalogAvailabilityPeriod](entity:CatalogAvailabilityPeriod) type and represents an availability period.\nThe availability period specific data must be stored on the `availability_period_data` field."}], "description": "Possible types of CatalogObjects returned from the catalog, each\ncontaining type-specific properties in the `*_data` field corresponding to the specified object type.", "x-release-status": "PUBLIC"}, "description": "The desired set of object types to appear in the search results.\n\nIf this is unspecified, the operation returns objects of all the top level types at the version\nof the Square API used to make the request. Object types that are nested onto other object types\nare not included in the defaults.\n\nAt the current API version the default object types are:\nITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, \nPRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,\nSUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.\n\nNote that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE,\nITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest\nin this field."}, "include_deleted_objects": {"type": "boolean", "description": "If `true`, deleted objects will be included in the results. Defaults to `false`. Deleted objects will have their `is_deleted` field set to `true`. If `include_deleted_objects` is `true`, then the `include_category_path_to_root` request parameter must be `false`. Both properties cannot be `true` at the same time."}, "include_related_objects": {"type": "boolean", "description": "If `true`, the response will include additional objects that are related to the\nrequested objects. Related objects are objects that are referenced by object ID by the objects\nin the response. This is helpful if the objects are being fetched for immediate display to a user.\nThis process only goes one level deep. Objects referenced by the related objects will not be included.\nFor example:\n\nIf the `objects` field of the response contains a CatalogItem, its associated\nCatalogCategory objects, CatalogTax objects, CatalogImage objects and\nCatalogModifierLists will be returned in the `related_objects` field of the\nresponse. If the `objects` field of the response contains a CatalogItemVariation,\nits parent CatalogItem will be returned in the `related_objects` field of\nthe response.\n\nDefault value: `false`"}, "begin_time": {"type": "string", "description": "Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339\nformat, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a\ntimestamp equal to `begin_time` will not be included in the response."}, "query": {"type": "object", "description": "A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.\n\nAlthough a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).\nAny combination of the following types may be used together:\n- [exact_query](entity:CatalogQueryExact)\n- [prefix_query](entity:CatalogQueryPrefix)\n- [range_query](entity:CatalogQueryRange)\n- [sorted_attribute_query](entity:CatalogQuerySortedAttribute)\n- [text_query](entity:CatalogQueryText)\n\nAll other query types cannot be combined with any others.\n\nWhen a query filter is based on an attribute, the attribute must be searchable.\nSearchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.\n\nSearchable attribute and objects queryable by searchable attributes:\n- `name`:  `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`\n- `description`: `CatalogItem`, `CatalogItemOptionValue`\n- `abbreviation`: `CatalogItem`\n- `upc`: `CatalogItemVariation`\n- `sku`: `CatalogItemVariation`\n- `caption`: `CatalogImage`\n- `display_name`: `CatalogItemOption`\n\nFor example, to search for [CatalogItem](entity:CatalogItem) objects by searchable attributes, you can use\nthe `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter.", "x-release-status": "PUBLIC", "properties": {"sorted_attribute_query": {"type": "object", "description": "The query expression to specify the key to sort search results.", "x-release-status": "PUBLIC", "required": ["attribute_name"], "properties": {"attribute_name": {"type": "string", "description": "The attribute whose value is used as the sort key.", "minLength": 1}, "initial_attribute_value": {"type": "string", "description": "The first attribute value to be returned by the query. Ascending sorts will return only\nobjects with this value or greater, while descending sorts will return only objects with this value\nor less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).", "nullable": true}, "sort_order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}}}, "exact_query": {"type": "object", "description": "The query filter to return the search result by exact match of the specified attribute name and value.", "x-release-status": "PUBLIC", "required": ["attribute_name", "attribute_value"], "properties": {"attribute_name": {"type": "string", "description": "The name of the attribute to be searched. Matching of the attribute name is exact.", "minLength": 1}, "attribute_value": {"type": "string", "description": "The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial.\nFor example, if a specified value of "sma", objects with the named attribute value of "Small", "small" are both matched."}}}, "set_query": {"type": "object", "description": "The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of\nthe `attribute_values`.", "x-release-status": "PUBLIC", "required": ["attribute_name", "attribute_values"], "properties": {"attribute_name": {"type": "string", "description": "The name of the attribute to be searched. Matching of the attribute name is exact.", "minLength": 1}, "attribute_values": {"type": "array", "items": {"type": "string"}, "description": "The desired values of the search attribute. Matching of the attribute values is exact and case insensitive.\nA maximum of 250 values may be searched in a request."}}}, "prefix_query": {"type": "object", "description": "The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.", "x-release-status": "PUBLIC", "required": ["attribute_name", "attribute_prefix"], "properties": {"attribute_name": {"type": "string", "description": "The name of the attribute to be searched.", "minLength": 1}, "attribute_prefix": {"type": "string", "description": "The desired prefix of the search attribute value.", "minLength": 1}}}, "range_query": {"type": "object", "description": "The query filter to return the search result whose named attribute values fall between the specified range.", "x-release-status": "PUBLIC", "required": ["attribute_name"], "properties": {"attribute_name": {"type": "string", "description": "The name of the attribute to be searched.", "minLength": 1}, "attribute_min_value": {"type": "integer", "description": "The desired minimum value for the search attribute (inclusive).", "format": "int64", "nullable": true}, "attribute_max_value": {"type": "integer", "description": "The desired maximum value for the search attribute (inclusive).", "format": "int64", "nullable": true}}}, "text_query": {"type": "object", "description": "The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.", "x-release-status": "PUBLIC", "required": ["keywords"], "properties": {"keywords": {"type": "array", "items": {"type": "string"}, "description": "A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored."}}}, "items_for_tax_query": {"type": "object", "description": "The query filter to return the items containing the specified tax IDs.", "x-release-status": "PUBLIC", "required": ["tax_ids"], "properties": {"tax_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s."}}}, "items_for_modifier_list_query": {"type": "object", "description": "The query filter to return the items containing the specified modifier list IDs.", "x-release-status": "PUBLIC", "required": ["modifier_list_ids"], "properties": {"modifier_list_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s."}}}, "items_for_item_options_query": {"type": "object", "description": "The query filter to return the items containing the specified item option IDs.", "x-release-status": "PUBLIC", "properties": {"item_option_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of `CatalogItemOption` IDs to be used to find associated\n`CatalogItem`s. All Items that contain all of the given Item Options (in any order)\nwill be returned.", "nullable": true}}}, "item_variations_for_item_option_values_query": {"type": "object", "description": "The query filter to return the item variations containing the specified item option value IDs.", "x-release-status": "PUBLIC", "properties": {"item_option_value_ids": {"type": "array", "items": {"type": "string"}, "description": "A set of `CatalogItemOptionValue` IDs to be used to find associated\n`CatalogItemVariation`s. All ItemVariations that contain all of the given\nItem Option Values (in any order) will be returned.", "nullable": true}}}}}, "limit": {"type": "integer", "description": "A limit on the number of results to be returned in a single page. The limit is advisory -\nthe implementation may return more or fewer results. If the supplied limit is negative, zero, or\nis higher than the maximum limit of 1,000, it will be ignored."}, "include_category_path_to_root": {"type": "boolean", "description": "Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload. If `include_category_path_to_root` is `true`, then the `include_deleted_objects` request parameter must be `false`. Both properties cannot be `true` at the same time."}}, "example": {"limit": 100, "object_types": ["ITEM"], "query": {"prefix_query": {"attribute_name": "name", "attribute_prefix": "tea"}}}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.csharp", "java": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.java", "javascript": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.javascript", "php": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.php", "python": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.python", "ruby": "/sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.ruby"}}',  # noqa: E501
    "SEARCHCATALOGITEMS": '{"type": "object", "description": "Defines the request body for the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint.", "x-release-status": "PUBLIC", "properties": {"text_filter": {"type": "string", "description": "The text filter expression to return items or item variations containing specified text in\nthe `name`, `description`, or `abbreviation` attribute value of an item, or in\nthe `name`, `sku`, or `upc` attribute value of an item variation."}, "category_ids": {"type": "array", "items": {"type": "string"}, "description": "The category id query expression to return items containing the specified category IDs."}, "stock_levels": {"type": "array", "items": {"type": "string", "enum": ["OUT", "LOW"], "x-enum-elements": [{"name": "OUT", "description": "The item inventory is empty."}, {"name": "LOW", "description": "The item inventory is low."}], "description": "Defines supported stock levels of the item inventory.", "x-release-status": "PUBLIC"}, "description": "The stock-level query expression to return item variations with the specified stock levels.\nSee [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values"}, "enabled_location_ids": {"type": "array", "items": {"type": "string"}, "description": "The enabled-location query expression to return items and item variations having specified enabled locations."}, "cursor": {"type": "string", "description": "The pagination token, returned in the previous response, used to fetch the next batch of pending results."}, "limit": {"type": "integer", "description": "The maximum number of results to return per page. The default value is 100.", "maximum": 100}, "sort_order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}, "product_types": {"type": "array", "items": {"type": "string", "enum": ["REGULAR", "GIFT_CARD", "APPOINTMENTS_SERVICE", "FOOD_AND_BEV", "EVENT", "DIGITAL", "DONATION", "LEGACY_SQUARE_ONLINE_SERVICE", "LEGACY_SQUARE_ONLINE_MEMBERSHIP"], "x-enum-elements": [{"name": "REGULAR", "description": "An ordinary item."}, {"name": "GIFT_CARD", "description": "A Square gift card."}, {"name": "APPOINTMENTS_SERVICE", "description": "A service that can be booked using the Square Appointments app."}, {"name": "FOOD_AND_BEV", "description": "A food or beverage item that can be sold by restaurants and other food venues."}, {"name": "EVENT", "description": "An event which tickets can be sold for, including location, address, and times."}, {"name": "DIGITAL", "description": "A digital item like an ebook or song."}, {"name": "DONATION", "description": "A donation which site visitors can send for any cause."}, {"name": "LEGACY_SQUARE_ONLINE_SERVICE", "description": "A legacy Square Online service that is manually fulfilled. This corresponds to the `Other` item type displayed in the Square Seller Dashboard and Square POS apps."}, {"name": "LEGACY_SQUARE_ONLINE_MEMBERSHIP", "description": "A legacy Square Online membership that is manually fulfilled. This corresponds to the `Membership` item type displayed in the Square Seller Dashboard and Square POS apps."}], "description": "The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.", "x-release-status": "PUBLIC"}, "description": "The product types query expression to return items or item variations having the specified product types."}, "custom_attribute_filters": {"type": "array", "items": {"type": "object", "description": "Supported custom attribute query expressions for calling the\n[SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)\nendpoint to search for items or item variations.", "x-release-status": "PUBLIC", "properties": {"custom_attribute_definition_id": {"type": "string", "description": "A query expression to filter items or item variations by matching their custom attributes\'\n`custom_attribute_definition_id` property value against the the specified id.\nExactly one of `custom_attribute_definition_id` or `key` must be specified.", "nullable": true}, "key": {"type": "string", "description": "A query expression to filter items or item variations by matching their custom attributes\'\n`key` property value against the specified key.\nExactly one of `custom_attribute_definition_id` or `key` must be specified.", "nullable": true}, "string_filter": {"type": "string", "description": "A query expression to filter items or item variations by matching their custom attributes\'\n`string_value`  property value against the specified text.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", "nullable": true}, "number_filter": {"type": "object", "description": "The range of a number value between the specified lower and upper bounds.", "x-release-status": "PUBLIC", "properties": {"min": {"type": "string", "description": "The lower bound of the number range. At least one of `min` or `max` must be specified.\nIf unspecified, the results will have no minimum value.", "nullable": true}, "max": {"type": "string", "description": "The upper bound of the number range. At least one of `min` or `max` must be specified.\nIf unspecified, the results will have no maximum value.", "nullable": true}}}, "selection_uids_filter": {"type": "array", "items": {"type": "string"}, "description": "A query expression to filter items or item variations by matching  their custom attributes\'\n`selection_uid_values` values against the specified selection uids.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", "nullable": true}, "bool_filter": {"type": "boolean", "description": "A query expression to filter items or item variations by matching their custom attributes\'\n`boolean_value` property values against the specified Boolean expression.\nExactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.", "nullable": true}}}, "description": "The customer-attribute filter to return items or item variations matching the specified\ncustom attribute expressions. A maximum number of 10 custom attribute expressions are supported in\na single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint."}, "archived_state": {"type": "string", "enum": ["ARCHIVED_STATE_NOT_ARCHIVED", "ARCHIVED_STATE_ARCHIVED", "ARCHIVED_STATE_ALL"], "x-enum-elements": [{"name": "ARCHIVED_STATE_NOT_ARCHIVED", "description": "Requested items are not archived with the `is_archived` attribute set to `false`."}, {"name": "ARCHIVED_STATE_ARCHIVED", "description": "Requested items are archived with the `is_archived` attribute set to `true`."}, {"name": "ARCHIVED_STATE_ALL", "description": "Requested items can be archived or not archived."}], "description": "Defines the values for the `archived_state` query expression \nused in [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) \nto return the archived, not archived or either type of catalog items.", "x-release-status": "PUBLIC"}}, "example": {"category_ids": ["WINE_CATEGORY_ID"], "custom_attribute_filters": [{"bool_filter": true, "custom_attribute_definition_id": "VEGAN_DEFINITION_ID"}, {"custom_attribute_definition_id": "BRAND_DEFINITION_ID", "string_filter": "Dark Horse"}, {"key": "VINTAGE", "number_filter": {"max": 2018, "min": 2017}}, {"custom_attribute_definition_id": "VARIETAL_DEFINITION_ID", "selection_ids_filter": "MERLOT_SELECTION_ID"}], "enabled_location_ids": ["ATL_LOCATION_ID"], "limit": 100, "product_types": ["REGULAR"], "sort_order": "ASC", "stock_levels": ["OUT", "LOW"], "text_filter": "red"}}',  # noqa: E501
    "CREATECUSTOMER": '{"type": "object", "description": "Defines the body parameters that can be included in a request to the\n`CreateCustomer` endpoint.", "x-release-status": "PUBLIC", "properties": {"idempotency_key": {"type": "string", "description": "The idempotency key for the request.\tFor more information, see\n[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."}, "given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters."}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters."}, "company_name": {"type": "string", "description": "A business name associated with the customer profile.\n\nThe maximum length for this value is 500 characters."}, "nickname": {"type": "string", "description": "A nickname for the customer profile.\n\nThe maximum length for this value is 100 characters."}, "email_address": {"type": "string", "description": "The email address associated with the customer profile.\n\nThe maximum length for this value is 254 characters."}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The phone number associated with the customer profile. The phone number must be valid and can contain\n9\u201316 digits, with an optional `+` prefix and country code. For more information, see\n[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number)."}, "reference_id": {"type": "string", "description": "An optional second ID used to associate the customer profile with an\nentity in another system.\n\nThe maximum length for this value is 100 characters."}, "note": {"type": "string", "description": "A custom note associated with the customer profile."}, "birthday": {"type": "string", "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,\nspecify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`\nformat, where `YYYY` is the specified birth year or `0000` if a birth year is not specified."}, "tax_ids": {"type": "object", "description": "Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.", "maxLength": 20, "nullable": true}}}}, "example": {"address": {"address_line_1": "500 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "email_address": "Amelia.Earhart@example.com", "family_name": "Earhart", "given_name": "Amelia", "note": "a customer", "phone_number": "+1-212-555-4240", "reference_id": "YOUR_REFERENCE_ID"}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/CreateCustomer/CreateCustomerRequest.csharp", "java": "/sdk_samples/CreateCustomer/CreateCustomerRequest.java", "javascript": "/sdk_samples/CreateCustomer/CreateCustomerRequest.javascript", "php": "/sdk_samples/CreateCustomer/CreateCustomerRequest.php", "python": "/sdk_samples/CreateCustomer/CreateCustomerRequest.python", "ruby": "/sdk_samples/CreateCustomer/CreateCustomerRequest.ruby"}}',  # noqa: E501
    "BULKCREATECUSTOMERS": '{"type": "object", "description": "Defines the body parameters that can be included in requests to the\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) endpoint.", "x-release-status": "PUBLIC", "required": ["customers"], "properties": {"customers": {"type": "object", "additionalProperties": {"type": "object", "description": "Defines the customer data provided in individual create requests for a\n[BulkCreateCustomers](api-endpoint:Customers-BulkCreateCustomers) operation.", "x-release-status": "PUBLIC", "properties": {"given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the customer profile.", "maxLength": 300, "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the customer profile.", "maxLength": 300, "nullable": true}, "company_name": {"type": "string", "description": "A business name associated with the customer profile.", "maxLength": 500, "nullable": true}, "nickname": {"type": "string", "description": "A nickname for the customer profile.", "maxLength": 100, "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the customer profile.", "maxLength": 254, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The phone number associated with the customer profile. The phone number must be valid\nand can contain 9\u201316 digits, with an optional `+` prefix and country code. For more information,\nsee [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", "nullable": true}, "reference_id": {"type": "string", "description": "An optional second ID used to associate the customer profile with an\nentity in another system.", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "A custom note associated with the customer profile.", "nullable": true}, "birthday": {"type": "string", "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format.\nFor example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21.\nBirthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or\n`0000` if a birth year is not specified.", "nullable": true}, "tax_ids": {"type": "object", "description": "Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.", "maxLength": 20, "nullable": true}}}}}, "description": "A map of 1 to 100 individual create requests, represented by `idempotency key: { customer data }`\nkey-value pairs.\n\nEach key is an [idempotency key](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)\nthat uniquely identifies the create request. Each value contains the customer data used to create the\ncustomer profile."}}, "example": {"customers": {"8bb76c4f-e35d-4c5b-90de-1194cd9179f0": {"address": {"address_line_1": "500 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "email_address": "Amelia.Earhart@example.com", "family_name": "Earhart", "given_name": "Amelia", "note": "a customer", "phone_number": "+1-212-555-4240", "reference_id": "YOUR_REFERENCE_ID"}, "d1689f23-b25d-4932-b2f0-aed00f5e2029": {"address": {"address_line_1": "500 Electric Ave", "address_line_2": "Suite 601", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "email_address": "Marie.Curie@example.com", "family_name": "Curie", "given_name": "Marie", "note": "another customer", "phone_number": "+1-212-444-4240", "reference_id": "YOUR_REFERENCE_ID"}}}}',  # noqa: E501
    "UPDATEMULTIPLECUSTOMERPROFILES": '{"type": "object", "description": "Defines the body parameters that can be included in requests to the\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) endpoint.", "x-release-status": "PUBLIC", "required": ["customers"], "properties": {"customers": {"type": "object", "additionalProperties": {"type": "object", "description": "Defines the customer data provided in individual update requests for a\n[BulkUpdateCustomers](api-endpoint:Customers-BulkUpdateCustomers) operation.", "x-release-status": "PUBLIC", "properties": {"given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the customer profile.", "maxLength": 300, "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the customer profile.", "maxLength": 300, "nullable": true}, "company_name": {"type": "string", "description": "A business name associated with the customer profile.", "maxLength": 500, "nullable": true}, "nickname": {"type": "string", "description": "A nickname for the customer profile.", "maxLength": 100, "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the customer profile.", "maxLength": 254, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The phone number associated with the customer profile. The phone number must be valid\nand can contain 9\u201316 digits, with an optional `+` prefix and country code. For more information,\nsee [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", "nullable": true}, "reference_id": {"type": "string", "description": "An optional second ID used to associate the customer profile with an\nentity in another system.", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "An custom note associates with the customer profile.", "nullable": true}, "birthday": {"type": "string", "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format.\nFor example, specify `1998-09-21` for September 21, 1998, or `09-21` for September 21.\nBirthdays are returned in `YYYY-MM-DD` format, where `YYYY` is the specified birth year or\n`0000` if a birth year is not specified.", "nullable": true}, "tax_ids": {"type": "object", "description": "Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.", "maxLength": 20, "nullable": true}}}, "version": {"type": "integer", "description": "The current version of the customer profile.\n\nAs a best practice, you should include this field to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol.", "format": "int64"}}}, "description": "A map of 1 to 100 individual update requests, represented by `customer ID: { customer data }`\nkey-value pairs.\n\nEach key is the ID of the [customer profile](entity:Customer) to update. To update a customer profile\nthat was created by merging existing profiles, provide the ID of the newly created profile.\n\nEach value contains the updated customer data. Only new or changed fields are required. To add or\nupdate a field, specify the new value. To remove a field, specify `null`."}}, "example": {"customers": {"8DDA5NZVBZFGAX0V3HPF81HHE0": {"email_address": "New.Amelia.Earhart@example.com", "note": "updated customer note", "phone_number": null, "version": 2}, "N18CPRVXR5214XPBBA6BZQWF3C": {"family_name": "Curie", "given_name": "Marie", "version": 0}}}}',  # noqa: E501
    "BULKUPSERTCUSTOMERATTRIBUTES": '{"type": "object", "description": "Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) request.", "x-release-status": "PUBLIC", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)\nrequest. An individual request contains a customer ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "PUBLIC", "required": ["customer_id", "custom_attribute"], "properties": {"customer_id": {"type": "string", "description": "The ID of the target [customer profile](entity:Customer).", "minLength": 1}, "custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}}, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertCustomerCustomAttributes` request and the\ninformation needed to create or update a custom attribute."}}, "example": {"values": {"id1": {"custom_attribute": {"key": "favoritemovie", "value": "Dune"}, "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8"}, "id2": {"custom_attribute": {"key": "ownsmovie", "value": false}, "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM"}, "id3": {"custom_attribute": {"key": "favoritemovie", "value": "Star Wars"}, "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM"}, "id4": {"custom_attribute": {"key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808", "value": "10.5"}, "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8"}, "id5": {"custom_attribute": {"key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail", "value": "fake-email@squareup.com"}, "customer_id": "70548QG1HN43B05G0KCZ4MMC1G"}}}}',  # noqa: E501
    "SEARCHSQUARECUSTOMERS": '{"type": "object", "description": "Defines the fields that are included in the request body of a request to the\n`SearchCustomers` endpoint.", "x-release-status": "PUBLIC", "properties": {"cursor": {"type": "string", "description": "Include the pagination cursor in subsequent calls to this endpoint to retrieve\nthe next set of results associated with the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."}, "limit": {"type": "integer", "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "format": "int64", "minimum": 1, "maximum": 100}, "query": {"type": "object", "description": "Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request.", "x-release-status": "PUBLIC", "properties": {"filter": {"type": "object", "description": "Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.", "x-release-status": "PUBLIC", "properties": {"creation_source": {"type": "object", "description": "The creation source filter.\n\nIf one or more creation sources are set, customer profiles are included in,\nor excluded from, the result if they match at least one of the filter criteria.", "x-release-status": "PUBLIC", "properties": {"values": {"type": "array", "items": {"type": "string", "enum": ["OTHER", "APPOINTMENTS", "COUPON", "DELETION_RECOVERY", "DIRECTORY", "EGIFTING", "EMAIL_COLLECTION", "FEEDBACK", "IMPORT", "INVOICES", "LOYALTY", "MARKETING", "MERGE", "ONLINE_STORE", "INSTANT_PROFILE", "TERMINAL", "THIRD_PARTY", "THIRD_PARTY_IMPORT", "UNMERGE_RECOVERY"], "x-enum-elements": [{"name": "OTHER", "description": "The default creation source. This source is typically used for backward/future\ncompatibility when the original source of a customer profile is\nunrecognized. For example, when older clients do not support newer\nsource types."}, {"name": "APPOINTMENTS", "description": "The customer profile was created automatically when an appointment\nwas scheduled."}, {"name": "COUPON", "description": "The customer profile was created automatically when a coupon was issued\nusing Square Point of Sale."}, {"name": "DELETION_RECOVERY", "description": "The customer profile was restored through Square\'s deletion recovery\nprocess."}, {"name": "DIRECTORY", "description": "The customer profile was created manually through Square Seller Dashboard or the \nPoint of Sale application."}, {"name": "EGIFTING", "description": "The customer profile was created automatically when a gift card was\nissued using Square Point of Sale. Customer profiles are created for\nboth the buyer and the recipient of the gift card."}, {"name": "EMAIL_COLLECTION", "description": "The customer profile was created through Square Point of Sale when\nsigning up for marketing emails during checkout."}, {"name": "FEEDBACK", "description": "The customer profile was created automatically when providing feedback\nthrough a digital receipt."}, {"name": "IMPORT", "description": "The customer profile was created automatically when importing customer\ndata through Square Seller Dashboard."}, {"name": "INVOICES", "description": "The customer profile was created automatically during an invoice payment."}, {"name": "LOYALTY", "description": "The customer profile was created automatically when customers provide a\nphone number for loyalty reward programs during checkout."}, {"name": "MARKETING", "description": "The customer profile was created as the result of a campaign managed\nthrough Square\u2019s Facebook integration."}, {"name": "MERGE", "description": "The customer profile was created as the result of explicitly merging\nmultiple customer profiles through the Square Seller Dashboard or the Point of\nSale application."}, {"name": "ONLINE_STORE", "description": "The customer profile was created through Square\'s Online Store solution\n(legacy service)."}, {"name": "INSTANT_PROFILE", "description": "The customer profile was created automatically as the result of a successful\ntransaction that did not explicitly link to an existing customer profile."}, {"name": "TERMINAL", "description": "The customer profile was created through Square\'s Virtual Terminal."}, {"name": "THIRD_PARTY", "description": "The customer profile was created through a Square API call."}, {"name": "THIRD_PARTY_IMPORT", "description": "The customer profile was created by a third-party product and imported\nthrough an official integration."}, {"name": "UNMERGE_RECOVERY", "description": "The customer profile was restored through Square\'s unmerge recovery\nprocess."}], "description": "Indicates the method used to create the customer profile.", "x-release-status": "PUBLIC"}, "description": "The list of creation sources used as filtering criteria.\nSee [CustomerCreationSource](#type-customercreationsource) for possible values", "nullable": true}, "rule": {"type": "string", "enum": ["INCLUDE", "EXCLUDE"], "x-enum-elements": [{"name": "INCLUDE", "description": "Customers should be included in the result set when they match the\nfiltering criteria."}, {"name": "EXCLUDE", "description": "Customers should be excluded from the result set when they match\nthe filtering criteria."}], "description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria.", "x-release-status": "PUBLIC"}}}, "created_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "updated_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "email_address": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "phone_number": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "reference_id": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "group_ids": {"type": "object", "description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field.", "x-release-status": "BETA", "properties": {"all": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must be present on the field of the resource.", "nullable": true}, "any": {"type": "array", "items": {"type": "string"}, "description": "A list of terms where at least one of them must be present on the\nfield of the resource.", "nullable": true}, "none": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must not be present on the field the resource", "nullable": true}}}, "custom_attribute": {"type": "object", "description": "The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).", "x-release-status": "PUBLIC", "properties": {"filters": {"type": "array", "items": {"type": "object", "description": "The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search\nbased on the value or last updated date of a customer-related [custom attribute](entity:CustomAttribute).", "x-release-status": "PUBLIC", "required": ["key"], "properties": {"key": {"type": "string", "description": "The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes)."}, "filter": {"type": "object", "description": "A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](entity:CustomAttribute).", "x-release-status": "PUBLIC", "properties": {"email": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "phone": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "text": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "selection": {"type": "object", "description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field.", "x-release-status": "BETA", "properties": {"all": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must be present on the field of the resource.", "nullable": true}, "any": {"type": "array", "items": {"type": "string"}, "description": "A list of terms where at least one of them must be present on the\nfield of the resource.", "nullable": true}, "none": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must not be present on the field the resource", "nullable": true}}}, "date": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "number": {"type": "object", "description": "Specifies a decimal number range.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A decimal value indicating where the range starts.", "nullable": true}, "end_at": {"type": "string", "description": "A decimal value indicating where the range ends.", "nullable": true}}}, "boolean": {"type": "boolean", "description": "A filter for a query based on the value of a `Boolean`-type custom attribute.", "nullable": true}, "address": {"type": "object", "description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.", "x-release-status": "PUBLIC", "properties": {"postal_code": {"type": "object", "description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.", "x-release-status": "PUBLIC", "properties": {"exact": {"type": "string", "description": "Use the exact filter to select customers whose attributes match exactly the specified query.", "nullable": true}, "fuzzy": {"type": "string", "description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation.", "nullable": true}}}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}}}}}, "updated_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}}}, "description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters.", "nullable": true}}}, "segment_ids": {"type": "object", "description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field.", "x-release-status": "BETA", "properties": {"all": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must be present on the field of the resource.", "nullable": true}, "any": {"type": "array", "items": {"type": "string"}, "description": "A list of terms where at least one of them must be present on the\nfield of the resource.", "nullable": true}, "none": {"type": "array", "items": {"type": "string"}, "description": "A list of terms that must not be present on the field the resource", "nullable": true}}}}}, "sort": {"type": "object", "description": "Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.", "x-release-status": "PUBLIC", "properties": {"field": {"type": "string", "enum": ["DEFAULT", "CREATED_AT"], "x-enum-elements": [{"name": "DEFAULT", "description": "Use the default sort key. By default, customers are sorted\nalphanumerically by concatenating their `given_name` and `family_name`. If\nneither name field is set, string comparison is performed using one of the\nremaining fields in the following order: `company_name`, `email`,\n`phone_number`."}, {"name": "CREATED_AT", "description": "Use the creation date attribute (`created_at`) of customer profiles as the sort key."}], "description": "Specifies customer attributes as the sort key to customer profiles returned from a search.", "x-release-status": "PUBLIC"}, "order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}}}}}, "count": {"type": "boolean", "description": "Indicates whether to return the total count of matching customers in the `count` field of the response.\n\nThe default value is `false`."}}, "example": {"limit": 2, "query": {"filter": {"created_at": {"end_at": "2018-02-01T00:00:00-00:00", "start_at": "2018-01-01T00:00:00-00:00"}, "creation_source": {"rule": "INCLUDE", "values": ["THIRD_PARTY"]}, "email_address": {"fuzzy": "example.com"}, "group_ids": {"all": ["545AXB44B4XXWMVQ4W8SBT3HHF"]}}, "sort": {"field": "CREATED_AT", "order": "ASC"}}}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/SearchCustomers/SearchCustomersRequest.csharp", "java": "/sdk_samples/SearchCustomers/SearchCustomersRequest.java", "javascript": "/sdk_samples/SearchCustomers/SearchCustomersRequest.javascript", "php": "/sdk_samples/SearchCustomers/SearchCustomersRequest.php", "python": "/sdk_samples/SearchCustomers/SearchCustomersRequest.python", "ruby": "/sdk_samples/SearchCustomers/SearchCustomersRequest.ruby"}}',  # noqa: E501
    "UPDATECUSTOMERPROFILE": '{"type": "object", "description": "Defines the body parameters that can be included in a request to the\n`UpdateCustomer` endpoint.", "x-release-status": "PUBLIC", "properties": {"given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters.", "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the customer profile.\n\nThe maximum length for this value is 300 characters.", "nullable": true}, "company_name": {"type": "string", "description": "A business name associated with the customer profile.\n\nThe maximum length for this value is 500 characters.", "nullable": true}, "nickname": {"type": "string", "description": "A nickname for the customer profile.\n\nThe maximum length for this value is 100 characters.", "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the customer profile.\n\nThe maximum length for this value is 254 characters.", "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The phone number associated with the customer profile. The phone number must be valid and can contain\n9\u201316 digits, with an optional `+` prefix and country code. For more information, see\n[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number).", "nullable": true}, "reference_id": {"type": "string", "description": "An optional second ID used to associate the customer profile with an\nentity in another system.\n\nThe maximum length for this value is 100 characters.", "nullable": true}, "note": {"type": "string", "description": "A custom note associated with the customer profile.", "nullable": true}, "birthday": {"type": "string", "description": "The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,\nspecify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`\nformat, where `YYYY` is the specified birth year or `0000` if a birth year is not specified.", "nullable": true}, "version": {"type": "integer", "description": "The current version of the customer profile.\n\nAs a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile).", "format": "int64"}, "tax_ids": {"type": "object", "description": "Represents the tax ID associated with a [customer profile](entity:Customer). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom. \nFor more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.", "maxLength": 20, "nullable": true}}}}, "example": {"email_address": "New.Amelia.Earhart@example.com", "note": "updated customer note", "phone_number": null, "version": 2}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.csharp", "java": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.java", "javascript": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.javascript", "php": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.php", "python": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.python", "ruby": "/sdk_samples/UpdateCustomer/UpdateCustomerRequest.ruby"}}',  # noqa: E501
    "UPDATECUSTOMERCUSTOMATTRIBUTE": '{"type": "object", "description": "Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) request.", "x-release-status": "PUBLIC", "x-params-example": "?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie", "required": ["custom_attribute"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}, "example": {"custom_attribute": {"value": "Dune"}}}',  # noqa: E501
    "CREATESQUARETERMINALDEVICECODE": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key", "device_code"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this CreateDeviceCode request. Keys can\nbe any valid string but must be unique for every CreateDeviceCode request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1, "maxLength": 128}, "device_code": {"type": "object", "x-release-status": "PUBLIC", "required": ["product_type"], "properties": {"id": {"type": "string", "description": "The unique id for this device code.", "readOnly": true}, "name": {"type": "string", "description": "An optional user-defined name for the device code.", "maxLength": 128, "nullable": true}, "code": {"type": "string", "description": "The unique code that can be used to login.", "readOnly": true}, "device_id": {"type": "string", "description": "The unique id of the device that used this code. Populated when the device is paired up.", "readOnly": true}, "product_type": {"type": "string", "enum": ["TERMINAL_API"], "x-enum-elements": [{"name": "TERMINAL_API", "description": ""}], "x-release-status": "PUBLIC"}, "location_id": {"type": "string", "description": "The location assigned to this code.", "maxLength": 50, "nullable": true}, "status": {"type": "string", "enum": ["UNKNOWN", "UNPAIRED", "PAIRED", "EXPIRED"], "x-enum-elements": [{"name": "UNKNOWN", "description": "The status cannot be determined or does not exist."}, {"name": "UNPAIRED", "description": "The device code is just created and unpaired."}, {"name": "PAIRED", "description": "The device code has been signed in and paired to a device."}, {"name": "EXPIRED", "description": "The device code was unpaired and expired before it was paired."}], "description": "DeviceCode.Status enum.", "x-release-status": "PUBLIC"}, "pair_by": {"type": "string", "description": "When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "When this DeviceCode was created. Timestamp in RFC 3339 format.", "readOnly": true}, "status_changed_at": {"type": "string", "description": "When this DeviceCode\'s status was last changed. Timestamp in RFC 3339 format.", "readOnly": true}, "paired_at": {"type": "string", "description": "When this DeviceCode was paired. Timestamp in RFC 3339 format.", "readOnly": true}}}}, "example": {"device_code": {"location_id": "B5E4484SHHNYH", "name": "Counter 1", "product_type": "TERMINAL_API"}, "idempotency_key": "01bb00a6-0c86-4770-94ed-f5fca973cd56"}}',  # noqa: E501
    "CREATEGIFTCARD": '{"type": "object", "description": "Represents a [CreateGiftCard](api-endpoint:GiftCards-CreateGiftCard) request.", "x-release-status": "PUBLIC", "required": ["idempotency_key", "location_id", "gift_card"], "properties": {"idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. For more information, \nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "minLength": 1, "maxLength": 128}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) where the gift card should be registered for \nreporting purposes. Gift cards can be redeemed at any of the seller\'s locations.", "minLength": 1}, "gift_card": {"type": "object", "description": "Represents a Square gift card.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the gift card.", "readOnly": true}, "type": {"type": "string", "enum": ["PHYSICAL", "DIGITAL"], "x-enum-elements": [{"name": "PHYSICAL", "description": "A plastic gift card."}, {"name": "DIGITAL", "description": "A digital gift card."}], "description": "Indicates the gift card type.", "x-release-status": "PUBLIC"}, "gan_source": {"type": "string", "enum": ["SQUARE", "OTHER"], "x-enum-elements": [{"name": "SQUARE", "description": "The GAN is generated by Square."}, {"name": "OTHER", "description": "The GAN is provided by a non-Square system. For more information, see \n[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans) or \n[Third-party gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#third-party-gift-cards)."}], "description": "Indicates the source that generated the gift card \naccount number (GAN).", "x-release-status": "PUBLIC"}, "state": {"type": "string", "enum": ["ACTIVE", "DEACTIVATED", "BLOCKED", "PENDING"], "x-enum-elements": [{"name": "ACTIVE", "description": "The gift card is active and can be used as a payment source."}, {"name": "DEACTIVATED", "description": "Any activity that changes the gift card balance is permanently forbidden."}, {"name": "BLOCKED", "description": "Any activity that changes the gift card balance is temporarily forbidden."}, {"name": "PENDING", "description": "The gift card is pending activation.\nThis is the initial state when a gift card is created. Typically, you\'ll call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create an\n`ACTIVATE` activity that activates the gift card with an initial balance before first use."}], "description": "Indicates the gift card state.", "x-release-status": "PUBLIC"}, "balance_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gan": {"type": "string", "description": "The gift card account number (GAN). Buyers can use the GAN to make purchases or check \nthe gift card balance.", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the gift card was created, in RFC 3339 format. \nIn the case of a digital gift card, it is the time when you create a card \n(using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).  \nIn the case of a plastic gift card, it is the time when Square associates the card with the \nseller at the time of activation.", "readOnly": true}, "customer_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked.", "readOnly": true}}}}, "example": {"gift_card": {"type": "DIGITAL"}, "idempotency_key": "NC9Tm69EjbjtConu", "location_id": "81FN9BNFZTKS4"}}',  # noqa: E501
    "CREATEGIFTCARDACTIVITY": '{"type": "object", "description": "A request to create a gift card activity.", "x-release-status": "PUBLIC", "required": ["idempotency_key", "gift_card_activity"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies the `CreateGiftCardActivity` request.", "minLength": 1, "maxLength": 128}, "gift_card_activity": {"type": "object", "description": "Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption.", "x-release-status": "PUBLIC", "required": ["type", "location_id"], "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the gift card activity.", "readOnly": true}, "type": {"type": "string", "enum": ["ACTIVATE", "LOAD", "REDEEM", "CLEAR_BALANCE", "DEACTIVATE", "ADJUST_INCREMENT", "ADJUST_DECREMENT", "REFUND", "UNLINKED_ACTIVITY_REFUND", "IMPORT", "BLOCK", "UNBLOCK", "IMPORT_REVERSAL", "TRANSFER_BALANCE_FROM", "TRANSFER_BALANCE_TO"], "x-enum-elements": [{"name": "ACTIVATE", "description": "Activated a gift card with a balance. When a gift card is activated, Square changes \nthe gift card state from `PENDING` to `ACTIVE`. A gift card must be in the `ACTIVE` state \nto be used for other balance-changing activities."}, {"name": "LOAD", "description": "Loaded a gift card with additional funds."}, {"name": "REDEEM", "description": "Redeemed a gift card for a purchase."}, {"name": "CLEAR_BALANCE", "description": "Set the balance of a gift card to zero."}, {"name": "DEACTIVATE", "description": "Permanently blocked a gift card from balance-changing activities."}, {"name": "ADJUST_INCREMENT", "description": "Added money to a gift card outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow."}, {"name": "ADJUST_DECREMENT", "description": "Deducted money from a gift card outside of a typical `REDEEM` activity flow."}, {"name": "REFUND", "description": "Added money to a gift card from a refunded transaction. A `REFUND` activity might be linked to \na Square payment, depending on how the payment and refund are processed. For example:\n- A payment processed by Square can be refunded to a `PENDING` or `ACTIVE` gift card using the Square\nSeller Dashboard, Square Point of Sale, or Refunds API.\n- A payment processed using a custom processing system can be refunded to the same gift card."}, {"name": "UNLINKED_ACTIVITY_REFUND", "description": "Added money to a gift card from a refunded transaction that was processed using a custom payment\nprocessing system and not linked to the gift card."}, {"name": "IMPORT", "description": "Imported a third-party gift card with a balance. `IMPORT` activities are managed \nby Square and cannot be created using the Gift Card Activities API."}, {"name": "BLOCK", "description": "Temporarily blocked a gift card from balance-changing activities. `BLOCK` activities \nare managed by Square and cannot be created using the Gift Card Activities API."}, {"name": "UNBLOCK", "description": "Unblocked a gift card, which enables it to resume balance-changing activities. `UNBLOCK` \nactivities are managed by Square and cannot be created using the Gift Card Activities API."}, {"name": "IMPORT_REVERSAL", "description": "Reversed the import of a third-party gift card, which sets the gift card state to \n`PENDING` and clears the balance. `IMPORT_REVERSAL` activities are managed by Square and \ncannot be created using the Gift Card Activities API."}, {"name": "TRANSFER_BALANCE_FROM", "description": "Deducted money from a gift card as the result of a transfer to the balance of another gift card.\n`TRANSFER_BALANCE_FROM` activities are managed by Square and cannot be created using the Gift Card Activities API."}, {"name": "TRANSFER_BALANCE_TO", "description": "Added money to a gift card as the result of a transfer from the balance of another gift card.\n`TRANSFER_BALANCE_TO` activities are managed by Square and cannot be created using the Gift Card Activities API."}], "description": "Indicates the type of [gift card activity](entity:GiftCardActivity).", "x-release-status": "PUBLIC"}, "location_id": {"type": "string", "description": "The ID of the [business location](entity:Location) where the activity occurred."}, "created_at": {"type": "string", "description": "The timestamp when the gift card activity was created, in RFC 3339 format.", "readOnly": true}, "gift_card_id": {"type": "string", "description": "The gift card ID. When creating a gift card activity, `gift_card_id` is not required if \n`gift_card_gan` is specified.", "nullable": true}, "gift_card_gan": {"type": "string", "description": "The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` \nis not required if `gift_card_id` is specified.", "nullable": true}, "gift_card_balance_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "load_activity_details": {"type": "object", "description": "Represents details about a `LOAD` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "order_id": {"type": "string", "description": "The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID in the \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", "nullable": true}, "line_item_uid": {"type": "string", "description": "The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", "nullable": true}, "reference_id": {"type": "string", "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom order processing system can use this field to track information related to \nan order or payment.", "nullable": true}, "buyer_payment_instrument_ids": {"type": "array", "items": {"type": "string"}, "description": "The payment instrument IDs used to process the order for the additional funds, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters.", "nullable": true}}}, "activate_activity_details": {"type": "object", "description": "Represents details about an `ACTIVATE` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "order_id": {"type": "string", "description": "The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.\n\nApplications that use the Square Orders API to process orders must specify the order ID\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", "nullable": true}, "line_item_uid": {"type": "string", "description": "The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.\n\nApplications that use the Square Orders API to process orders must specify the line item UID\nin the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.", "nullable": true}, "reference_id": {"type": "string", "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom order processing system can use this field to track information \nrelated to an order or payment.", "nullable": true}, "buyer_payment_instrument_ids": {"type": "array", "items": {"type": "string"}, "description": "The payment instrument IDs used to process the gift card purchase, such as a credit card ID \nor bank account ID. \n\nApplications that use a custom order processing system must specify payment instrument IDs in \nthe [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.\nSquare uses this information to perform compliance checks. \n\nFor applications that use the Square Orders API to process payments, Square has the necessary \ninstrument IDs to perform compliance checks.\n\nEach buyer payment instrument ID can contain a maximum of 255 characters.", "nullable": true}}}, "redeem_activity_details": {"type": "object", "description": "Represents details about a `REDEEM` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["amount_money"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "payment_id": {"type": "string", "description": "The ID of the payment that represents the gift card redemption. Square populates this field \nif the payment was processed by Square.", "readOnly": true}, "reference_id": {"type": "string", "description": "A client-specified ID that associates the gift card activity with an entity in another system. \n\nApplications that use a custom payment processing system can use this field to track information\nrelated to an order or payment.", "nullable": true}, "status": {"type": "string", "enum": ["PENDING", "COMPLETED", "CANCELED"], "x-enum-elements": [{"name": "PENDING", "description": "The gift card redemption is pending. `PENDING` is a temporary status that applies when a \ngift card is redeemed from Square Point of Sale or another Square product. A `PENDING` status is updated to \n`COMPLETED` if the payment is captured or `CANCELED` if the authorization is voided."}, {"name": "COMPLETED", "description": "The gift card redemption is completed."}, {"name": "CANCELED", "description": "The gift card redemption is canceled. A redemption is canceled if the authorization \non the gift card is voided."}], "description": "Indicates the status of a [gift card](entity:GiftCard) redemption. This status is relevant only for\nredemptions made from Square products (such as Square Point of Sale) because Square products use a \ntwo-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.", "x-release-status": "PUBLIC"}}}, "clear_balance_activity_details": {"type": "object", "description": "Represents details about a `CLEAR_BALANCE` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["reason"], "properties": {"reason": {"type": "string", "enum": ["SUSPICIOUS_ACTIVITY", "REUSE_GIFTCARD", "UNKNOWN_REASON"], "x-enum-elements": [{"name": "SUSPICIOUS_ACTIVITY", "description": "The seller suspects suspicious activity."}, {"name": "REUSE_GIFTCARD", "description": "The seller cleared the balance to reuse the gift card."}, {"name": "UNKNOWN_REASON", "description": "The gift card balance was cleared for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API."}], "description": "Indicates the reason for clearing the balance of a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "deactivate_activity_details": {"type": "object", "description": "Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["reason"], "properties": {"reason": {"type": "string", "enum": ["SUSPICIOUS_ACTIVITY", "UNKNOWN_REASON", "CHARGEBACK_DEACTIVATE"], "x-enum-elements": [{"name": "SUSPICIOUS_ACTIVITY", "description": "The seller suspects suspicious activity."}, {"name": "UNKNOWN_REASON", "description": "The gift card was deactivated for an unknown reason.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API."}, {"name": "CHARGEBACK_DEACTIVATE", "description": "A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.\n\nThis reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API."}], "description": "Indicates the reason for deactivating a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "adjust_increment_activity_details": {"type": "object", "description": "Represents details about an `ADJUST_INCREMENT` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["amount_money", "reason"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reason": {"type": "string", "enum": ["COMPLIMENTARY", "SUPPORT_ISSUE", "TRANSACTION_VOIDED"], "x-enum-elements": [{"name": "COMPLIMENTARY", "description": "The seller gifted a complimentary gift card balance increase."}, {"name": "SUPPORT_ISSUE", "description": "The seller increased the gift card balance \nto accommodate support issues."}, {"name": "TRANSACTION_VOIDED", "description": "The transaction is voided."}], "description": "Indicates the reason for adding money to a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "adjust_decrement_activity_details": {"type": "object", "description": "Represents details about an `ADJUST_DECREMENT` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["amount_money", "reason"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reason": {"type": "string", "enum": ["SUSPICIOUS_ACTIVITY", "BALANCE_ACCIDENTALLY_INCREASED", "SUPPORT_ISSUE", "PURCHASE_WAS_REFUNDED"], "x-enum-elements": [{"name": "SUSPICIOUS_ACTIVITY", "description": "The balance was decreased because the seller detected suspicious or fraudulent activity\non the gift card."}, {"name": "BALANCE_ACCIDENTALLY_INCREASED", "description": "The balance was decreased to reverse an unintentional balance increase."}, {"name": "SUPPORT_ISSUE", "description": "The balance was decreased to accommodate support issues."}, {"name": "PURCHASE_WAS_REFUNDED", "description": "The balance was decreased because the order used to purchase or reload the\ngift card was refunded."}], "description": "Indicates the reason for deducting money from a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "refund_activity_details": {"type": "object", "description": "Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "properties": {"redeem_activity_id": {"type": "string", "description": "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request \nrepresents a gift card redemption.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reference_id": {"type": "string", "description": "A client-specified ID that associates the gift card activity with an entity in another system.", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the refunded payment. Square populates this field if the refund is for a \npayment processed by Square. This field matches the `payment_id` in the corresponding\n[RefundPayment](api-endpoint:Refunds-RefundPayment) request.", "readOnly": true}}}, "unlinked_activity_refund_activity_details": {"type": "object", "description": "Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["amount_money"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reference_id": {"type": "string", "description": "A client-specified ID that associates the gift card activity with an entity in another system.", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the refunded payment. This field is not used starting in Square version 2022-06-16.", "readOnly": true}}}, "import_activity_details": {"type": "object", "description": "Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`.", "x-release-status": "PUBLIC", "required": ["amount_money"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "block_activity_details": {"type": "object", "description": "Represents details about a `BLOCK` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["reason"], "properties": {"reason": {"type": "string", "enum": ["CHARGEBACK_BLOCK"], "x-enum-elements": [{"name": "CHARGEBACK_BLOCK", "description": "The gift card is blocked because the buyer initiated a chargeback on the gift card purchase."}], "description": "Indicates the reason for blocking a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "unblock_activity_details": {"type": "object", "description": "Represents details about an `UNBLOCK` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["reason"], "properties": {"reason": {"type": "string", "enum": ["CHARGEBACK_UNBLOCK"], "x-enum-elements": [{"name": "CHARGEBACK_UNBLOCK", "description": "The gift card is unblocked because a chargeback was ruled in favor of the seller."}], "description": "Indicates the reason for unblocking a [gift card](entity:GiftCard).", "x-release-status": "PUBLIC"}}}, "import_reversal_activity_details": {"type": "object", "description": "Represents details about an `IMPORT_REVERSAL` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["amount_money"], "properties": {"amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "transfer_balance_to_activity_details": {"type": "object", "description": "Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["transfer_from_gift_card_id", "amount_money"], "properties": {"transfer_from_gift_card_id": {"type": "string", "description": "The ID of the gift card from which the specified amount was transferred."}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "transfer_balance_from_activity_details": {"type": "object", "description": "Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](entity:GiftCardActivityType).", "x-release-status": "PUBLIC", "required": ["transfer_to_gift_card_id", "amount_money"], "properties": {"transfer_to_gift_card_id": {"type": "string", "description": "The ID of the gift card to which the specified amount was transferred."}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}}, "example": {"gift_card_activity": {"activate_activity_details": {"line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx", "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"}, "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20", "location_id": "81FN9BNFZTKS4", "type": "ACTIVATE"}, "idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY"}}',  # noqa: E501
    "APPLYINVENTORYADJUSTMENTS": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key"], "properties": {"idempotency_key": {"type": "string", "description": "A client-supplied, universally unique identifier (UUID) for the\nrequest.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", "minLength": 1, "maxLength": 128}, "changes": {"type": "array", "items": {"type": "object", "description": "Represents a single physical count, inventory, adjustment, or transfer\nthat is part of the history of inventory changes for a particular\n[CatalogObject](entity:CatalogObject) instance.", "x-release-status": "PUBLIC", "properties": {"type": {"type": "string", "enum": ["PHYSICAL_COUNT", "ADJUSTMENT", "TRANSFER"], "x-enum-elements": [{"name": "PHYSICAL_COUNT", "description": "The change occurred as part of a physical count update."}, {"name": "ADJUSTMENT", "description": "The change occurred as part of the normal lifecycle of goods\n(e.g., as an inventory adjustment)."}, {"name": "TRANSFER", "description": "The change occurred as part of an inventory transfer."}], "description": "Indicates how the inventory change was applied to a tracked product quantity.", "x-release-status": "PUBLIC"}, "physical_count": {"type": "object", "description": "Represents the quantity of an item variation that is physically present\nat a specific location, verified by a seller or a seller\'s employee. For example,\na physical count might come from an employee counting the item variations on\nhand or from syncing with an external system.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount).", "maxLength": 100}, "reference_id": {"type": "string", "description": "An optional ID provided by the application to tie the\n[InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external\nsystem.", "maxLength": 255, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", "maxLength": 100, "nullable": true}, "catalog_object_type": {"type": "string", "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. \nIn addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.", "maxLength": 14, "nullable": true}, "state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}, "location_id": {"type": "string", "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items is being tracked.", "maxLength": 100, "nullable": true}, "quantity": {"type": "string", "description": "The number of items affected by the physical count as a decimal string.\nThe number can support up to 5 digits after the decimal point.", "maxLength": 26, "nullable": true}, "source": {"type": "object", "description": "Represents information about the application used to generate a change.", "x-release-status": "PUBLIC", "properties": {"product": {"type": "string", "enum": ["SQUARE_POS", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "DASHBOARD", "ITEM_LIBRARY_IMPORT", "OTHER"], "x-enum-elements": [{"name": "SQUARE_POS", "description": "Square Point of Sale application."}, {"name": "EXTERNAL_API", "description": "Square Connect APIs (for example, Orders API or Checkout API)."}, {"name": "BILLING", "description": "A Square subscription (various products)."}, {"name": "APPOINTMENTS", "description": "Square Appointments."}, {"name": "INVOICES", "description": "Square Invoices."}, {"name": "ONLINE_STORE", "description": "Square Online Store."}, {"name": "PAYROLL", "description": "Square Payroll."}, {"name": "DASHBOARD", "description": "Square Dashboard."}, {"name": "ITEM_LIBRARY_IMPORT", "description": "Item Library Import."}, {"name": "OTHER", "description": "A Square product that does not match any other value."}], "description": "Indicates the Square product used to generate a change.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", "nullable": true}, "name": {"type": "string", "description": "__Read only__ The display name of the application\n(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).", "nullable": true}}}, "employee_id": {"type": "string", "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\nphysical count.", "maxLength": 100, "nullable": true}, "team_member_id": {"type": "string", "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\nphysical count.", "maxLength": 100, "nullable": true}, "occurred_at": {"type": "string", "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe physical count was examined. For physical count updates, the `occurred_at`\ntimestamp cannot be older than 24 hours or in the future relative to the\ntime of the request.", "maxLength": 34, "nullable": true}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the physical count is received.", "maxLength": 34, "readOnly": true}}}, "adjustment": {"type": "object", "description": "Represents a change in state or quantity of product inventory at a\nparticular time and location.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique ID generated by Square for the\n`InventoryAdjustment`.", "maxLength": 100}, "reference_id": {"type": "string", "description": "An optional ID provided by the application to tie the\n`InventoryAdjustment` to an external\nsystem.", "maxLength": 255, "nullable": true}, "from_state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}, "to_state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}, "location_id": {"type": "string", "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items is being tracked.", "maxLength": 100, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", "maxLength": 100, "nullable": true}, "catalog_object_type": {"type": "string", "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. \nIn addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.", "maxLength": 14, "nullable": true}, "quantity": {"type": "string", "description": "The number of items affected by the adjustment as a decimal string.\nCan support up to 5 digits after the decimal point.", "maxLength": 26, "nullable": true}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "occurred_at": {"type": "string", "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe inventory adjustment took place. For inventory adjustment updates, the `occurred_at`\ntimestamp cannot be older than 24 hours or in the future relative to the\ntime of the request.", "maxLength": 34, "nullable": true}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.", "maxLength": 34, "readOnly": true}, "source": {"type": "object", "description": "Represents information about the application used to generate a change.", "x-release-status": "PUBLIC", "properties": {"product": {"type": "string", "enum": ["SQUARE_POS", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "DASHBOARD", "ITEM_LIBRARY_IMPORT", "OTHER"], "x-enum-elements": [{"name": "SQUARE_POS", "description": "Square Point of Sale application."}, {"name": "EXTERNAL_API", "description": "Square Connect APIs (for example, Orders API or Checkout API)."}, {"name": "BILLING", "description": "A Square subscription (various products)."}, {"name": "APPOINTMENTS", "description": "Square Appointments."}, {"name": "INVOICES", "description": "Square Invoices."}, {"name": "ONLINE_STORE", "description": "Square Online Store."}, {"name": "PAYROLL", "description": "Square Payroll."}, {"name": "DASHBOARD", "description": "Square Dashboard."}, {"name": "ITEM_LIBRARY_IMPORT", "description": "Item Library Import."}, {"name": "OTHER", "description": "A Square product that does not match any other value."}], "description": "Indicates the Square product used to generate a change.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", "nullable": true}, "name": {"type": "string", "description": "__Read only__ The display name of the application\n(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).", "nullable": true}}}, "employee_id": {"type": "string", "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\ninventory adjustment.", "maxLength": 100, "nullable": true}, "team_member_id": {"type": "string", "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\ninventory adjustment.", "maxLength": 100, "nullable": true}, "transaction_id": {"type": "string", "description": "The Square-generated ID of the [Transaction](entity:Transaction) that\ncaused the adjustment. Only relevant for payment-related state\ntransitions.", "maxLength": 255, "readOnly": true}, "refund_id": {"type": "string", "description": "The Square-generated ID of the [Refund](entity:Refund) that\ncaused the adjustment. Only relevant for refund-related state\ntransitions.", "maxLength": 255, "readOnly": true}, "purchase_order_id": {"type": "string", "description": "The Square-generated ID of the purchase order that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp.", "maxLength": 100, "readOnly": true}, "goods_receipt_id": {"type": "string", "description": "The Square-generated ID of the goods receipt that caused the\nadjustment. Only relevant for state transitions from the Square for Retail\napp.", "maxLength": 100, "readOnly": true}, "adjustment_group": {"type": "object", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique ID generated by Square for the\n`InventoryAdjustmentGroup`.", "maxLength": 100, "readOnly": true}, "root_adjustment_id": {"type": "string", "description": "The inventory adjustment of the composed variation.", "maxLength": 100, "readOnly": true}, "from_state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}, "to_state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}}}}}, "transfer": {"type": "object", "description": "Represents the transfer of a quantity of product inventory at a\nparticular time from one location to another.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique ID generated by Square for the\n`InventoryTransfer`.", "maxLength": 100}, "reference_id": {"type": "string", "description": "An optional ID provided by the application to tie the\n`InventoryTransfer` to an external system.", "maxLength": 255, "nullable": true}, "state": {"type": "string", "enum": ["CUSTOM", "IN_STOCK", "SOLD", "RETURNED_BY_CUSTOMER", "RESERVED_FOR_SALE", "SOLD_ONLINE", "ORDERED_FROM_VENDOR", "RECEIVED_FROM_VENDOR", "IN_TRANSIT_TO", "NONE", "WASTE", "UNLINKED_RETURN", "COMPOSED", "DECOMPOSED", "SUPPORTED_BY_NEWER_VERSION", "IN_TRANSIT"], "x-enum-elements": [{"name": "CUSTOM", "description": "The related quantity of items are in a custom state. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "IN_STOCK", "description": "The related quantity of items are on hand and available for sale."}, {"name": "SOLD", "description": "The related quantity of items were sold as part of an itemized\ntransaction. Quantities in the `SOLD` state are no longer tracked."}, {"name": "RETURNED_BY_CUSTOMER", "description": "The related quantity of items were returned through the Square Point\nof Sale application, but are not yet available for sale. **READ-ONLY**:\nthe Inventory API cannot move quantities to or from this state."}, {"name": "RESERVED_FOR_SALE", "description": "The related quantity of items are on hand, but not currently\navailable for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "SOLD_ONLINE", "description": "The related quantity of items were sold online. **READ-ONLY**: the\nInventory API cannot move quantities to or from this state."}, {"name": "ORDERED_FROM_VENDOR", "description": "The related quantity of items were ordered from a vendor but not yet\nreceived. **READ-ONLY**: the Inventory API cannot move quantities to or\nfrom this state."}, {"name": "RECEIVED_FROM_VENDOR", "description": "The related quantity of items were received from a vendor but are\nnot yet available for sale. **READ-ONLY**: the Inventory API cannot move\nquantities to or from this state."}, {"name": "IN_TRANSIT_TO", "description": "Replaced by `IN_TRANSIT` to represent quantities\nof items that are in transit between locations."}, {"name": "NONE", "description": "A placeholder indicating that the related quantity of items are not\ncurrently tracked in Square. Transferring quantities from the `NONE` state\nto a tracked state (e.g., `IN_STOCK`) introduces stock into the system."}, {"name": "WASTE", "description": "The related quantity of items are lost or damaged and cannot be\nsold."}, {"name": "UNLINKED_RETURN", "description": "The related quantity of items were returned but not linked to a\nprevious transaction. Unlinked returns are not tracked in Square.\nTransferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,\n`IN_STOCK`) introduces new stock into the system."}, {"name": "COMPOSED", "description": "The related quantity of items that are part of a composition consisting one or more components."}, {"name": "DECOMPOSED", "description": "The related quantity of items that are part of a component."}, {"name": "SUPPORTED_BY_NEWER_VERSION", "description": "This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state."}, {"name": "IN_TRANSIT", "description": "The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state."}], "description": "Indicates the state of a tracked item quantity in the lifecycle of goods.", "x-release-status": "PUBLIC"}, "from_location_id": {"type": "string", "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items was tracked before the transfer.", "maxLength": 100, "nullable": true}, "to_location_id": {"type": "string", "description": "The Square-generated ID of the [Location](entity:Location) where the related\nquantity of items was tracked after the transfer.", "maxLength": 100, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The Square-generated ID of the\n[CatalogObject](entity:CatalogObject) being tracked.", "maxLength": 100, "nullable": true}, "catalog_object_type": {"type": "string", "description": "The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked. \n\nThe Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. \nIn addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.", "maxLength": 14, "nullable": true}, "quantity": {"type": "string", "description": "The number of items affected by the transfer as a decimal string.\nCan support up to 5 digits after the decimal point.", "maxLength": 26, "nullable": true}, "occurred_at": {"type": "string", "description": "A client-generated RFC 3339-formatted timestamp that indicates when\nthe transfer took place. For write actions, the `occurred_at` timestamp\ncannot be older than 24 hours or in the future relative to the time of the\nrequest.", "maxLength": 34, "nullable": true}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when Square\nreceived the transfer request.", "maxLength": 34, "readOnly": true}, "source": {"type": "object", "description": "Represents information about the application used to generate a change.", "x-release-status": "PUBLIC", "properties": {"product": {"type": "string", "enum": ["SQUARE_POS", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "DASHBOARD", "ITEM_LIBRARY_IMPORT", "OTHER"], "x-enum-elements": [{"name": "SQUARE_POS", "description": "Square Point of Sale application."}, {"name": "EXTERNAL_API", "description": "Square Connect APIs (for example, Orders API or Checkout API)."}, {"name": "BILLING", "description": "A Square subscription (various products)."}, {"name": "APPOINTMENTS", "description": "Square Appointments."}, {"name": "INVOICES", "description": "Square Invoices."}, {"name": "ONLINE_STORE", "description": "Square Online Store."}, {"name": "PAYROLL", "description": "Square Payroll."}, {"name": "DASHBOARD", "description": "Square Dashboard."}, {"name": "ITEM_LIBRARY_IMPORT", "description": "Item Library Import."}, {"name": "OTHER", "description": "A Square product that does not match any other value."}], "description": "Indicates the Square product used to generate a change.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "__Read only__ The Square-assigned ID of the application. This field is used only if the\n[product](entity:Product) type is `EXTERNAL_API`.", "nullable": true}, "name": {"type": "string", "description": "__Read only__ The display name of the application\n(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).", "nullable": true}}}, "employee_id": {"type": "string", "description": "The Square-generated ID of the [Employee](entity:Employee) responsible for the\ninventory transfer.", "maxLength": 100, "nullable": true}, "team_member_id": {"type": "string", "description": "The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the\ninventory transfer.", "maxLength": 100, "nullable": true}}}, "measurement_unit": {"type": "object", "description": "Represents the unit used to measure a `CatalogItemVariation` and\nspecifies the precision for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in quantities measured with this unit.\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 3", "nullable": true}}}, "measurement_unit_id": {"type": "string", "description": "The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change.", "readOnly": true}}}, "description": "The set of physical counts and inventory adjustments to be made.\nChanges are applied based on the client-supplied timestamp and may be sent\nout of order.", "nullable": true}, "ignore_unchanged_counts": {"type": "boolean", "description": "Indicates whether the current physical count should be ignored if\nthe quantity is unchanged since the last physical count. Default: `true`.", "nullable": true}}, "example": {"changes": [{"physical_count": {"catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI", "location_id": "C6W5YS5QM06F5", "occurred_at": "2016-11-16T22:25:24.878Z", "quantity": "53", "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92", "state": "IN_STOCK", "team_member_id": "LRK57NSQ5X7PUD05"}, "type": "PHYSICAL_COUNT"}], "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "ignore_unchanged_counts": true}, "x-sq-sdk-sample-code": {"csharp": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.csharp", "java": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.java", "javascript": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.javascript", "php": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.php", "python": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.python", "ruby": "/sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.ruby"}}',  # noqa: E501
    "CREATEDRAFTINVOICE": '{"type": "object", "description": "Describes a `CreateInvoice` request.", "x-release-status": "PUBLIC", "required": ["invoice"], "properties": {"invoice": {"type": "object", "description": "Stores information about an invoice. You use the Invoices API to create and manage\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the invoice.", "readOnly": true}, "version": {"type": "integer", "description": "The Square-assigned version number, which is incremented each time an update is committed to the invoice."}, "location_id": {"type": "string", "description": "The ID of the location that this invoice is associated with. \n\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.", "minLength": 1, "maxLength": 255, "nullable": true}, "order_id": {"type": "string", "description": "The ID of the [order](entity:Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID.", "minLength": 1, "maxLength": 255, "nullable": true}, "primary_recipient": {"type": "object", "description": "Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \nand that Square uses to deliver the invoice.\n\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \nSquare updates the customer ID in response to a merge operation, but does not update other fields.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer. This is the customer profile ID that \nyou provide when creating a draft invoice.", "minLength": 1, "maxLength": 255, "nullable": true}, "given_name": {"type": "string", "description": "The recipient\'s given (that is, first) name.", "readOnly": true}, "family_name": {"type": "string", "description": "The recipient\'s family (that is, last) name.", "readOnly": true}, "email_address": {"type": "string", "description": "The recipient\'s email address.", "readOnly": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The recipient\'s phone number.", "readOnly": true}, "company_name": {"type": "string", "description": "The name of the recipient\'s company.", "readOnly": true}, "tax_ids": {"type": "object", "description": "Represents the tax IDs for an invoice recipient. The country of the seller account determines \nwhether the corresponding `tax_ids` field is available for the customer. For more information, \nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the invoice recipient. For example, `IE3426675K`.", "readOnly": true}}}}}, "payment_requests": {"type": "array", "items": {"type": "object", "description": "Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "The Square-generated ID of the payment request in an [invoice](entity:Invoice).", "minLength": 1, "maxLength": 255, "nullable": true}, "request_method": {"type": "string", "enum": ["EMAIL", "CHARGE_CARD_ON_FILE", "SHARE_MANUALLY", "CHARGE_BANK_ON_FILE", "SMS", "SMS_CHARGE_CARD_ON_FILE", "SMS_CHARGE_BANK_ON_FILE"], "x-enum-elements": [{"name": "EMAIL", "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](entity:Invoice))."}, {"name": "CHARGE_CARD_ON_FILE", "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request\nand to use email to send invoices, reminders, and receipts."}, {"name": "SHARE_MANUALLY", "description": "Directs Square to take no specific action on the invoice. In this case, the seller \n(or the application developer) follows up with the customer for payment. For example, \na seller might collect a payment in the Seller Dashboard or use the Point of Sale (POS) application. \nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer requesting payment."}, {"name": "CHARGE_BANK_ON_FILE", "description": "Directs Square to charge the customer\'s bank account on file and to use email to send invoices, reminders, and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. You \ncannot set `CHARGE_BANK_ON_FILE` as a request method using the Invoices API."}, {"name": "SMS", "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](entity:Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API."}, {"name": "SMS_CHARGE_CARD_ON_FILE", "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request and to\nuse SMS (text message) to send invoices and receipts. \n\nYou cannot set `SMS_CHARGE_CARD_ON_FILE` as a request method using the Invoices API."}, {"name": "SMS_CHARGE_BANK_ON_FILE", "description": "Directs Square to charge the customer\'s bank account on file and to use SMS (text message) to send invoices and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard\nor other Square product. The bank account is provided by the customer during the payment flow. \nYou cannot set `SMS_CHARGE_BANK_ON_FILE` as a request method using the Invoices API."}], "description": "Specifies the action for Square to take for processing the invoice. For example, \nemail the invoice, charge a customer\'s card on file, or do nothing. DEPRECATED at\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.", "x-release-status": "DEPRECATED"}, "request_type": {"type": "string", "enum": ["BALANCE", "DEPOSIT", "INSTALLMENT"], "x-enum-elements": [{"name": "BALANCE", "description": "A request for a balance payment. The balance amount is computed as follows: \n\n- If the invoice specifies only a balance payment request, the balance amount is the \ntotal amount of the associated order. \n- If the invoice also specifies a deposit request, the balance amount is the amount \nremaining after the deposit.\n\n`INSTALLMENT` and `BALANCE` payment requests are not allowed in the same invoice."}, {"name": "DEPOSIT", "description": "A request for a deposit payment. You have the option of specifying \nan exact amount or a percentage of the total order amount. If you request a deposit, \nit must be due before any other payment requests."}, {"name": "INSTALLMENT", "description": "A request for an installment payment. Installments allow buyers to pay the invoice over time. Installments can optionally be combined with a deposit. \n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)."}], "description": "Indicates the type of the payment request. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).", "x-release-status": "PUBLIC"}, "due_date": {"type": "string", "description": "The due date (in the invoice\'s time zone) for the payment request, in `YYYY-MM-DD` format. This field\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\ncharges the payment source on this date.\n\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\nof America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC\ntimestamp of 2021-03-10T08:00:00Z).", "nullable": true}, "fixed_amount_requested_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "percentage_requested": {"type": "string", "description": "Specifies the amount for the payment request in percentage:\n\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order\'s total amount.\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order\'s total less \nthe deposit, if requested. The sum of the `percentage_requested` in all installment \npayment requests must be equal to 100.\n\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \npayment request specifies the `fixed_amount_requested_money` field.", "nullable": true}, "tipping_enabled": {"type": "boolean", "description": "If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \nprovides a place for the customer to pay a tip. \n\nThis field is allowed only on the final payment request  \nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`.", "nullable": true}, "automatic_payment_source": {"type": "string", "enum": ["NONE", "CARD_ON_FILE", "BANK_ON_FILE"], "x-enum-elements": [{"name": "NONE", "description": "An automatic payment is not configured for the payment request."}, {"name": "CARD_ON_FILE", "description": "Use a card on file as the automatic payment method. On the due date, Square charges the card\nfor the amount of the payment request.\n\nFor `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be\nspecified for the payment request before the invoice can be published."}, {"name": "BANK_ON_FILE", "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\nrequest to approve the payment when the invoice is sent or the invoice is updated.\n\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`."}], "description": "Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest).", "x-release-status": "PUBLIC"}, "card_id": {"type": "string", "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.", "minLength": 1, "maxLength": 255, "nullable": true}, "reminders": {"type": "array", "items": {"type": "object", "description": "Describes a payment request reminder (automatic notification) that Square sends\nto the customer. You configure a reminder relative to the payment request\n`due_date`.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A Square-assigned ID that uniquely identifies the reminder within the\n`InvoicePaymentRequest`.", "readOnly": true}, "relative_scheduled_days": {"type": "integer", "description": "The number of days before (a negative number) or after (a positive number)\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\nthe reminder should be sent 3 days before the payment request `due_date`.", "minimum": -32767, "maximum": 32767, "nullable": true}, "message": {"type": "string", "description": "The reminder message.", "minLength": 1, "maxLength": 1000, "nullable": true}, "status": {"type": "string", "enum": ["PENDING", "NOT_APPLICABLE", "SENT"], "x-enum-elements": [{"name": "PENDING", "description": "The reminder will be sent on the `relative_scheduled_date` (if the invoice is published)."}, {"name": "NOT_APPLICABLE", "description": "The reminder is not applicable and is not sent. The following are examples\nof when reminders are not applicable and are not sent:\n- You schedule a reminder to be sent before the invoice is published.\n- The invoice is configured with multiple payment requests and a payment request reminder\nis configured to be sent after the next payment request `due_date`.\n- Two reminders (for different payment requests) are configured to be sent on the\nsame date. Therefore, only one reminder is sent.\n- You configure a reminder to be sent on the date that the invoice is scheduled to be sent.\n- The payment request is already paid.\n- The invoice status is `CANCELED` or `FAILED`."}, {"name": "SENT", "description": "The reminder is sent."}], "description": "The status of a payment request reminder.", "x-release-status": "PUBLIC"}, "sent_at": {"type": "string", "description": "If sent, the timestamp when the reminder was sent, in RFC 3339 format.", "readOnly": true}}}, "description": "A list of one or more reminders to send for the payment request.", "nullable": true}, "computed_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_completed_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "rounding_adjustment_included_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2\u201312 installments \n- One deposit with 2\u201312 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "nullable": true}, "delivery_method": {"type": "string", "enum": ["EMAIL", "SHARE_MANUALLY", "SMS"], "x-enum-elements": [{"name": "EMAIL", "description": "Directs Square to send invoices, reminders, and receipts to the customer using email."}, {"name": "SHARE_MANUALLY", "description": "Directs Square to take no action on the invoice. In this case, the seller\nor application developer follows up with the customer for payment. For example,\na seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.\nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment."}, {"name": "SMS", "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`."}], "description": "Indicates how Square delivers the [invoice](entity:Invoice) to the customer.", "x-release-status": "PUBLIC"}, "invoice_number": {"type": "string", "description": "A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\nIf not provided when creating an invoice, Square assigns a value.\nIt increments from 1 and is padded with zeros making it 7 characters long\n(for example, 0000001 and 0000002).", "minLength": 1, "maxLength": 191, "nullable": true}, "title": {"type": "string", "description": "The title of the invoice, which is displayed on the invoice.", "minLength": 1, "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "The description of the invoice, which is displayed on the invoice.", "minLength": 1, "maxLength": 65536, "nullable": true}, "scheduled_at": {"type": "string", "description": "The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\nAfter the invoice is published, Square processes the invoice on the specified date,\naccording to the delivery method and payment request settings.\n\nIf the field is not set, Square processes the invoice immediately after it is published.", "nullable": true}, "public_url": {"type": "string", "description": "A temporary link to the Square-hosted payment page where the customer can pay the\ninvoice. If the link expires, customers can provide the email address or phone number\nassociated with the invoice and request a new link directly from the expired payment page. \n\nThis field is added after the invoice is published and reaches the scheduled date\n(if one is defined).", "readOnly": true}, "next_payment_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["DRAFT", "UNPAID", "SCHEDULED", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED", "CANCELED", "FAILED", "PAYMENT_PENDING"], "x-enum-elements": [{"name": "DRAFT", "description": "The invoice is a draft. You must publish a draft invoice before Square can process it.\nA draft invoice has no `public_url`, so it is not available to customers."}, {"name": "UNPAID", "description": "The invoice is published but not yet paid."}, {"name": "SCHEDULED", "description": "The invoice is scheduled to be processed. On the scheduled date,\nSquare sends the invoice, initiates an automatic payment, or takes no action, depending on\nthe delivery method and payment request settings. Square also sets the invoice status to the\nappropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`."}, {"name": "PARTIALLY_PAID", "description": "A partial payment is received for the invoice."}, {"name": "PAID", "description": "The customer paid the invoice in full."}, {"name": "PARTIALLY_REFUNDED", "description": "The invoice is paid (or partially paid) and some but not all the amount paid is\nrefunded."}, {"name": "REFUNDED", "description": "The full amount that the customer paid for the invoice is refunded."}, {"name": "CANCELED", "description": "The invoice is canceled. Square no longer requests payments from the customer.\nThe Square-hosted payment page is still accessible using the temporary `public_url`\nlink, but the invoice is shown as canceled and does not accept payment."}, {"name": "FAILED", "description": "Square canceled the invoice due to suspicious activity."}, {"name": "PAYMENT_PENDING", "description": "A payment on the invoice was initiated but has not yet been processed.\n\nWhen in this state, invoices cannot be updated and other payments cannot be initiated."}], "description": "Indicates the status of an [invoice](entity:Invoice).", "x-release-status": "PUBLIC"}, "timezone": {"type": "string", "description": "The time zone used to interpret calendar dates on the invoice, such as `due_date`.\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\nlocation. The value cannot be changed.\n\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles\nbecomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp\nof 2021-03-10T08:00:00Z).", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp when the invoice was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the invoice was last updated, in RFC 3339 format.", "readOnly": true}, "accepted_payment_methods": {"type": "object", "description": "The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page.", "x-release-status": "PUBLIC", "properties": {"card": {"type": "boolean", "description": "Indicates whether credit card or debit card payments are accepted. The default value is `false`.", "nullable": true}, "square_gift_card": {"type": "boolean", "description": "Indicates whether Square gift card payments are accepted. The default value is `false`.", "nullable": true}, "bank_account": {"type": "boolean", "description": "Indicates whether ACH bank transfer payments are accepted. The default value is `false`.", "nullable": true}, "buy_now_pay_later": {"type": "boolean", "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later).", "nullable": true}, "cash_app_pay": {"type": "boolean", "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](entity:Location) in the United States.", "nullable": true}}}, "custom_fields": {"type": "array", "items": {"type": "object", "description": "An additional seller-defined and customer-facing field to include on the invoice. For more information, \nsee [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC", "properties": {"label": {"type": "string", "description": "The label or title of the custom field. This field is required for a custom field.", "maxLength": 30, "nullable": true}, "value": {"type": "string", "description": "The text of the custom field. If omitted, only the label is rendered.", "maxLength": 2000, "nullable": true}, "placement": {"type": "string", "enum": ["ABOVE_LINE_ITEMS", "BELOW_LINE_ITEMS"], "x-enum-elements": [{"name": "ABOVE_LINE_ITEMS", "description": "Render the custom field above the invoice line items."}, {"name": "BELOW_LINE_ITEMS", "description": "Render the custom field below the invoice line items."}], "description": "Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \ncopies of the invoice.", "x-release-status": "PUBLIC"}}}, "description": "Additional seller-defined fields that are displayed on the invoice. For more information, see\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\n\nMax: 2 custom fields", "nullable": true}, "subscription_id": {"type": "string", "description": "The ID of the [subscription](entity:Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", "readOnly": true}, "sale_or_service_date": {"type": "string", "description": "The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\nThis field can be used to specify a past or future date which is displayed on the invoice.", "nullable": true}, "payment_conditions": {"type": "string", "description": "**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\n\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \n"Payment conditions are not supported for this location\'s country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.", "minLength": 1, "maxLength": 2000, "nullable": true}, "store_payment_method_enabled": {"type": "boolean", "description": "Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`.", "nullable": true}, "attachments": {"type": "array", "items": {"type": "object", "description": "Represents a file attached to an [invoice](entity:Invoice).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the attachment.", "readOnly": true}, "filename": {"type": "string", "description": "The file name of the attachment, which is displayed on the invoice.", "readOnly": true}, "description": {"type": "string", "description": "The description of the attachment, which is displayed on the invoice.\nThis field maps to the seller-defined **Message** field.", "readOnly": true}, "filesize": {"type": "integer", "description": "The file size of the attachment in bytes.", "readOnly": true}, "hash": {"type": "string", "description": "The MD5 hash that was generated from the file contents.", "readOnly": true}, "mime_type": {"type": "string", "description": "The mime type of the attachment.\nThe following mime types are supported: \nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf.", "readOnly": true}, "uploaded_at": {"type": "string", "description": "The timestamp when the attachment was uploaded, in RFC 3339 format.", "readOnly": true}}}, "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints.", "readOnly": true}, "creator_team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) who created the invoice.\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique string that identifies the `CreateInvoice` request. If you do not \nprovide `idempotency_key` (or provide an empty string as the value), the endpoint \ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 128}}, "example": {"idempotency_key": "ce3748f9-5fc1-4762-aa12-aae5e843f1f4", "invoice": {"accepted_payment_methods": {"bank_account": false, "buy_now_pay_later": false, "card": true, "cash_app_pay": false, "square_gift_card": false}, "custom_fields": [{"label": "Event Reference Number", "placement": "ABOVE_LINE_ITEMS", "value": "Ref. #1234"}, {"label": "Terms of Service", "placement": "BELOW_LINE_ITEMS", "value": "The terms of service are..."}], "delivery_method": "EMAIL", "description": "We appreciate your business!", "invoice_number": "inv-100", "location_id": "ES0RJRZYEC39A", "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", "payment_requests": [{"automatic_payment_source": "NONE", "due_date": "2030-01-24", "reminders": [{"message": "Your invoice is due tomorrow", "relative_scheduled_days": -1}], "request_type": "BALANCE", "tipping_enabled": true}], "primary_recipient": {"customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4"}, "sale_or_service_date": "2030-01-24", "scheduled_at": "2030-01-13T10:00:00Z", "store_payment_method_enabled": false, "title": "Event Planning Services"}}}',  # noqa: E501
    "UPDATEINVOICE": '{"type": "object", "description": "Describes a `UpdateInvoice` request.", "x-release-status": "PUBLIC", "required": ["invoice"], "properties": {"invoice": {"type": "object", "description": "Stores information about an invoice. You use the Invoices API to create and manage\ninvoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the invoice.", "readOnly": true}, "version": {"type": "integer", "description": "The Square-assigned version number, which is incremented each time an update is committed to the invoice."}, "location_id": {"type": "string", "description": "The ID of the location that this invoice is associated with. \n\nIf specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.", "minLength": 1, "maxLength": 255, "nullable": true}, "order_id": {"type": "string", "description": "The ID of the [order](entity:Order) for which the invoice is created. \nThis field is required when creating an invoice, and the order must be in the `OPEN` state.\n\nTo view the line items and other information for the associated order, call the \n[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID.", "minLength": 1, "maxLength": 255, "nullable": true}, "primary_recipient": {"type": "object", "description": "Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice \nand that Square uses to deliver the invoice.\n\nWhen you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates \nthe remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published. \nSquare updates the customer ID in response to a merge operation, but does not update other fields.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer. This is the customer profile ID that \nyou provide when creating a draft invoice.", "minLength": 1, "maxLength": 255, "nullable": true}, "given_name": {"type": "string", "description": "The recipient\'s given (that is, first) name.", "readOnly": true}, "family_name": {"type": "string", "description": "The recipient\'s family (that is, last) name.", "readOnly": true}, "email_address": {"type": "string", "description": "The recipient\'s email address.", "readOnly": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "phone_number": {"type": "string", "description": "The recipient\'s phone number.", "readOnly": true}, "company_name": {"type": "string", "description": "The name of the recipient\'s company.", "readOnly": true}, "tax_ids": {"type": "object", "description": "Represents the tax IDs for an invoice recipient. The country of the seller account determines \nwhether the corresponding `tax_ids` field is available for the customer. For more information, \nsee [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).", "x-release-status": "PUBLIC", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT identification number for the invoice recipient. For example, `IE3426675K`.", "readOnly": true}}}}}, "payment_requests": {"type": "array", "items": {"type": "object", "description": "Represents a payment request for an [invoice](entity:Invoice). Invoices can specify a maximum\nof 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information, \nsee [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "The Square-generated ID of the payment request in an [invoice](entity:Invoice).", "minLength": 1, "maxLength": 255, "nullable": true}, "request_method": {"type": "string", "enum": ["EMAIL", "CHARGE_CARD_ON_FILE", "SHARE_MANUALLY", "CHARGE_BANK_ON_FILE", "SMS", "SMS_CHARGE_CARD_ON_FILE", "SMS_CHARGE_BANK_ON_FILE"], "x-enum-elements": [{"name": "EMAIL", "description": "Directs Square to send invoices, reminders, and receipts to the customer using email.\nSquare sends the invoice after it is published (either immediately or at the `scheduled_at`\ntime, if specified in the [invoice](entity:Invoice))."}, {"name": "CHARGE_CARD_ON_FILE", "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request\nand to use email to send invoices, reminders, and receipts."}, {"name": "SHARE_MANUALLY", "description": "Directs Square to take no specific action on the invoice. In this case, the seller \n(or the application developer) follows up with the customer for payment. For example, \na seller might collect a payment in the Seller Dashboard or use the Point of Sale (POS) application. \nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer requesting payment."}, {"name": "CHARGE_BANK_ON_FILE", "description": "Directs Square to charge the customer\'s bank account on file and to use email to send invoices, reminders, and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. You \ncannot set `CHARGE_BANK_ON_FILE` as a request method using the Invoices API."}, {"name": "SMS", "description": "Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice\nafter it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](entity:Invoice)). \n\nYou cannot set `SMS` as a request method using the Invoices API."}, {"name": "SMS_CHARGE_CARD_ON_FILE", "description": "Directs Square to charge the card on file on the `due_date` specified in the payment request and to\nuse SMS (text message) to send invoices and receipts. \n\nYou cannot set `SMS_CHARGE_CARD_ON_FILE` as a request method using the Invoices API."}, {"name": "SMS_CHARGE_BANK_ON_FILE", "description": "Directs Square to charge the customer\'s bank account on file and to use SMS (text message) to send invoices and receipts.\nThe customer must approve the payment.\n\nThe bank on file payment method applies only to invoices that sellers create in the Seller Dashboard\nor other Square product. The bank account is provided by the customer during the payment flow. \nYou cannot set `SMS_CHARGE_BANK_ON_FILE` as a request method using the Invoices API."}], "description": "Specifies the action for Square to take for processing the invoice. For example, \nemail the invoice, charge a customer\'s card on file, or do nothing. DEPRECATED at\nversion 2021-01-21. The corresponding `request_method` field is replaced by the\n`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.", "x-release-status": "DEPRECATED"}, "request_type": {"type": "string", "enum": ["BALANCE", "DEPOSIT", "INSTALLMENT"], "x-enum-elements": [{"name": "BALANCE", "description": "A request for a balance payment. The balance amount is computed as follows: \n\n- If the invoice specifies only a balance payment request, the balance amount is the \ntotal amount of the associated order. \n- If the invoice also specifies a deposit request, the balance amount is the amount \nremaining after the deposit.\n\n`INSTALLMENT` and `BALANCE` payment requests are not allowed in the same invoice."}, {"name": "DEPOSIT", "description": "A request for a deposit payment. You have the option of specifying \nan exact amount or a percentage of the total order amount. If you request a deposit, \nit must be due before any other payment requests."}, {"name": "INSTALLMENT", "description": "A request for an installment payment. Installments allow buyers to pay the invoice over time. Installments can optionally be combined with a deposit. \n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)."}], "description": "Indicates the type of the payment request. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).", "x-release-status": "PUBLIC"}, "due_date": {"type": "string", "description": "The due date (in the invoice\'s time zone) for the payment request, in `YYYY-MM-DD` format. This field\nis required to create a payment request. If an `automatic_payment_source` is defined for the request, Square\ncharges the payment source on this date.\n\nAfter this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`\nof America/Los\\_Angeles becomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC\ntimestamp of 2021-03-10T08:00:00Z).", "nullable": true}, "fixed_amount_requested_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "percentage_requested": {"type": "string", "description": "Specifies the amount for the payment request in percentage:\n\n- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order\'s total amount.\n- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order\'s total less \nthe deposit, if requested. The sum of the `percentage_requested` in all installment \npayment requests must be equal to 100.\n\nYou cannot specify this when the payment `request_type` is `BALANCE` or when the \npayment request specifies the `fixed_amount_requested_money` field.", "nullable": true}, "tipping_enabled": {"type": "boolean", "description": "If set to true, the Square-hosted invoice page (the `public_url` field of the invoice) \nprovides a place for the customer to pay a tip. \n\nThis field is allowed only on the final payment request  \nand the payment `request_type` must be `BALANCE` or `INSTALLMENT`.", "nullable": true}, "automatic_payment_source": {"type": "string", "enum": ["NONE", "CARD_ON_FILE", "BANK_ON_FILE"], "x-enum-elements": [{"name": "NONE", "description": "An automatic payment is not configured for the payment request."}, {"name": "CARD_ON_FILE", "description": "Use a card on file as the automatic payment method. On the due date, Square charges the card\nfor the amount of the payment request.\n\nFor `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be\nspecified for the payment request before the invoice can be published."}, {"name": "BANK_ON_FILE", "description": "Use a bank account on file as the automatic payment method. On the due date, Square charges the bank\naccount for the amount of the payment request if the buyer has approved the payment. The buyer receives a\nrequest to approve the payment when the invoice is sent or the invoice is updated.\n\nThis payment method applies only to invoices that sellers create in the Seller Dashboard or other\nSquare product. The bank account is provided by the customer during the payment flow. \n\nYou cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`\npayment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`."}], "description": "Indicates the automatic payment method for an [invoice payment request](entity:InvoicePaymentRequest).", "x-release-status": "PUBLIC"}, "card_id": {"type": "string", "description": "The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,\ncall [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.", "minLength": 1, "maxLength": 255, "nullable": true}, "reminders": {"type": "array", "items": {"type": "object", "description": "Describes a payment request reminder (automatic notification) that Square sends\nto the customer. You configure a reminder relative to the payment request\n`due_date`.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A Square-assigned ID that uniquely identifies the reminder within the\n`InvoicePaymentRequest`.", "readOnly": true}, "relative_scheduled_days": {"type": "integer", "description": "The number of days before (a negative number) or after (a positive number)\nthe payment request `due_date` when the reminder is sent. For example, -3 indicates that\nthe reminder should be sent 3 days before the payment request `due_date`.", "minimum": -32767, "maximum": 32767, "nullable": true}, "message": {"type": "string", "description": "The reminder message.", "minLength": 1, "maxLength": 1000, "nullable": true}, "status": {"type": "string", "enum": ["PENDING", "NOT_APPLICABLE", "SENT"], "x-enum-elements": [{"name": "PENDING", "description": "The reminder will be sent on the `relative_scheduled_date` (if the invoice is published)."}, {"name": "NOT_APPLICABLE", "description": "The reminder is not applicable and is not sent. The following are examples\nof when reminders are not applicable and are not sent:\n- You schedule a reminder to be sent before the invoice is published.\n- The invoice is configured with multiple payment requests and a payment request reminder\nis configured to be sent after the next payment request `due_date`.\n- Two reminders (for different payment requests) are configured to be sent on the\nsame date. Therefore, only one reminder is sent.\n- You configure a reminder to be sent on the date that the invoice is scheduled to be sent.\n- The payment request is already paid.\n- The invoice status is `CANCELED` or `FAILED`."}, {"name": "SENT", "description": "The reminder is sent."}], "description": "The status of a payment request reminder.", "x-release-status": "PUBLIC"}, "sent_at": {"type": "string", "description": "If sent, the timestamp when the reminder was sent, in RFC 3339 format.", "readOnly": true}}}, "description": "A list of one or more reminders to send for the payment request.", "nullable": true}, "computed_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_completed_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "rounding_adjustment_included_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The payment schedule for the invoice, represented by one or more payment requests that\ndefine payment settings, such as amount due and due date. An invoice supports the following payment request combinations:\n- One balance\n- One deposit with one balance\n- 2\u201312 installments \n- One deposit with 2\u201312 installments\n\nThis field is required when creating an invoice. It must contain at least one payment request. \nAll payment requests for the invoice must equal the total order amount. For more information, see \n[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).\n\nAdding `INSTALLMENT` payment requests to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "nullable": true}, "delivery_method": {"type": "string", "enum": ["EMAIL", "SHARE_MANUALLY", "SMS"], "x-enum-elements": [{"name": "EMAIL", "description": "Directs Square to send invoices, reminders, and receipts to the customer using email."}, {"name": "SHARE_MANUALLY", "description": "Directs Square to take no action on the invoice. In this case, the seller\nor application developer follows up with the customer for payment. For example,\na seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.\nThe seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment."}, {"name": "SMS", "description": "Directs Square to send invoices and receipts to the customer using SMS (text message).\n\nYou cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`."}], "description": "Indicates how Square delivers the [invoice](entity:Invoice) to the customer.", "x-release-status": "PUBLIC"}, "invoice_number": {"type": "string", "description": "A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.\nIf not provided when creating an invoice, Square assigns a value.\nIt increments from 1 and is padded with zeros making it 7 characters long\n(for example, 0000001 and 0000002).", "minLength": 1, "maxLength": 191, "nullable": true}, "title": {"type": "string", "description": "The title of the invoice, which is displayed on the invoice.", "minLength": 1, "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "The description of the invoice, which is displayed on the invoice.", "minLength": 1, "maxLength": 65536, "nullable": true}, "scheduled_at": {"type": "string", "description": "The timestamp when the invoice is scheduled for processing, in RFC 3339 format.\nAfter the invoice is published, Square processes the invoice on the specified date,\naccording to the delivery method and payment request settings.\n\nIf the field is not set, Square processes the invoice immediately after it is published.", "nullable": true}, "public_url": {"type": "string", "description": "A temporary link to the Square-hosted payment page where the customer can pay the\ninvoice. If the link expires, customers can provide the email address or phone number\nassociated with the invoice and request a new link directly from the expired payment page. \n\nThis field is added after the invoice is published and reaches the scheduled date\n(if one is defined).", "readOnly": true}, "next_payment_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["DRAFT", "UNPAID", "SCHEDULED", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED", "CANCELED", "FAILED", "PAYMENT_PENDING"], "x-enum-elements": [{"name": "DRAFT", "description": "The invoice is a draft. You must publish a draft invoice before Square can process it.\nA draft invoice has no `public_url`, so it is not available to customers."}, {"name": "UNPAID", "description": "The invoice is published but not yet paid."}, {"name": "SCHEDULED", "description": "The invoice is scheduled to be processed. On the scheduled date,\nSquare sends the invoice, initiates an automatic payment, or takes no action, depending on\nthe delivery method and payment request settings. Square also sets the invoice status to the\nappropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`."}, {"name": "PARTIALLY_PAID", "description": "A partial payment is received for the invoice."}, {"name": "PAID", "description": "The customer paid the invoice in full."}, {"name": "PARTIALLY_REFUNDED", "description": "The invoice is paid (or partially paid) and some but not all the amount paid is\nrefunded."}, {"name": "REFUNDED", "description": "The full amount that the customer paid for the invoice is refunded."}, {"name": "CANCELED", "description": "The invoice is canceled. Square no longer requests payments from the customer.\nThe Square-hosted payment page is still accessible using the temporary `public_url`\nlink, but the invoice is shown as canceled and does not accept payment."}, {"name": "FAILED", "description": "Square canceled the invoice due to suspicious activity."}, {"name": "PAYMENT_PENDING", "description": "A payment on the invoice was initiated but has not yet been processed.\n\nWhen in this state, invoices cannot be updated and other payments cannot be initiated."}], "description": "Indicates the status of an [invoice](entity:Invoice).", "x-release-status": "PUBLIC"}, "timezone": {"type": "string", "description": "The time zone used to interpret calendar dates on the invoice, such as `due_date`.\nWhen an invoice is created, this field is set to the `timezone` specified for the seller\nlocation. The value cannot be changed.\n\nFor example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\\_Angeles\nbecomes overdue at midnight on March 9 in America/Los\\_Angeles (which equals a UTC timestamp\nof 2021-03-10T08:00:00Z).", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp when the invoice was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the invoice was last updated, in RFC 3339 format.", "readOnly": true}, "accepted_payment_methods": {"type": "object", "description": "The payment methods that customers can use to pay an [invoice](entity:Invoice) on the Square-hosted invoice payment page.", "x-release-status": "PUBLIC", "properties": {"card": {"type": "boolean", "description": "Indicates whether credit card or debit card payments are accepted. The default value is `false`.", "nullable": true}, "square_gift_card": {"type": "boolean", "description": "Indicates whether Square gift card payments are accepted. The default value is `false`.", "nullable": true}, "bank_account": {"type": "boolean", "description": "Indicates whether ACH bank transfer payments are accepted. The default value is `false`.", "nullable": true}, "buy_now_pay_later": {"type": "boolean", "description": "Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.\n\nThis option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is\nsupported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay\ninvoice payments are supported. As a best practice, consider enabling an additional payment method when allowing\n`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see\n[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later).", "nullable": true}, "cash_app_pay": {"type": "boolean", "description": "Indicates whether Cash App payments are accepted. The default value is `false`.\n\nThis payment method is supported only for seller [locations](entity:Location) in the United States.", "nullable": true}}}, "custom_fields": {"type": "array", "items": {"type": "object", "description": "An additional seller-defined and customer-facing field to include on the invoice. For more information, \nsee [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).", "x-release-status": "PUBLIC", "properties": {"label": {"type": "string", "description": "The label or title of the custom field. This field is required for a custom field.", "maxLength": 30, "nullable": true}, "value": {"type": "string", "description": "The text of the custom field. If omitted, only the label is rendered.", "maxLength": 2000, "nullable": true}, "placement": {"type": "string", "enum": ["ABOVE_LINE_ITEMS", "BELOW_LINE_ITEMS"], "x-enum-elements": [{"name": "ABOVE_LINE_ITEMS", "description": "Render the custom field above the invoice line items."}, {"name": "BELOW_LINE_ITEMS", "description": "Render the custom field below the invoice line items."}], "description": "Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF \ncopies of the invoice.", "x-release-status": "PUBLIC"}}}, "description": "Additional seller-defined fields that are displayed on the invoice. For more information, see\n[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).\n\nAdding custom fields to an invoice requires an \n[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).\n\nMax: 2 custom fields", "nullable": true}, "subscription_id": {"type": "string", "description": "The ID of the [subscription](entity:Subscription) associated with the invoice.\nThis field is present only on subscription billing invoices.", "readOnly": true}, "sale_or_service_date": {"type": "string", "description": "The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.\nThis field can be used to specify a past or future date which is displayed on the invoice.", "nullable": true}, "payment_conditions": {"type": "string", "description": "**France only.** The payment terms and conditions that are displayed on the invoice. For more information, \nsee [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).\n\nFor countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and \n"Payment conditions are not supported for this location\'s country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.", "minLength": 1, "maxLength": 2000, "nullable": true}, "store_payment_method_enabled": {"type": "boolean", "description": "Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a\nbank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the\ninvoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`.", "nullable": true}, "attachments": {"type": "array", "items": {"type": "object", "description": "Represents a file attached to an [invoice](entity:Invoice).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the attachment.", "readOnly": true}, "filename": {"type": "string", "description": "The file name of the attachment, which is displayed on the invoice.", "readOnly": true}, "description": {"type": "string", "description": "The description of the attachment, which is displayed on the invoice.\nThis field maps to the seller-defined **Message** field.", "readOnly": true}, "filesize": {"type": "integer", "description": "The file size of the attachment in bytes.", "readOnly": true}, "hash": {"type": "string", "description": "The MD5 hash that was generated from the file contents.", "readOnly": true}, "mime_type": {"type": "string", "description": "The mime type of the attachment.\nThe following mime types are supported: \nimage/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf.", "readOnly": true}, "uploaded_at": {"type": "string", "description": "The timestamp when the attachment was uploaded, in RFC 3339 format.", "readOnly": true}}}, "description": "Metadata about the attachments on the invoice. Invoice attachments are managed using the\n[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints.", "readOnly": true}, "creator_team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) who created the invoice.\nThis field is present only on invoices created in the Square Dashboard or Square Invoices app by a logged-in team member.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique string that identifies the `UpdateInvoice` request. If you do not\nprovide `idempotency_key` (or provide an empty string as the value), the endpoint\ntreats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 128, "nullable": true}, "fields_to_clear": {"type": "array", "items": {"type": "string"}, "description": "The list of fields to clear. Although this field is currently supported, we\nrecommend using null values or the `remove` field when possible. For examples, see\n[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices).", "nullable": true}}, "example": {"idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be", "invoice": {"payment_requests": [{"reminders": null, "tipping_enabled": false, "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"}], "version": 1}}}',  # noqa: E501
    "CREATESCHEDULEDSHIFT": '{"type": "object", "description": "Represents a [CreateScheduledShift](api-endpoint:Labor-CreateScheduledShift) request.", "x-release-status": "BETA", "required": ["scheduled_shift"], "properties": {"idempotency_key": {"type": "string", "description": "A unique identifier for the `CreateScheduledShift` request, used to ensure the\n[idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)\nof the operation.", "maxLength": 128}, "scheduled_shift": {"type": "object", "description": "Represents a specific time slot in a work schedule. This object is used to manage the\nlifecycle of a scheduled shift from the draft to published state. A scheduled shift contains\nthe latest draft shift details and current published shift details.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "**Read only** The Square-issued ID of the scheduled shift.", "maxLength": 255}, "draft_shift_details": {"type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift),\nsuch as job ID, team member assignment, and start and end times.", "x-release-status": "BETA", "properties": {"team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) scheduled for the shift.", "maxLength": 255, "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) the shift is scheduled for.", "maxLength": 255, "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) the shift is scheduled for.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "end_at": {"type": "string", "description": "The end time for the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "notes": {"type": "string", "description": "Optional notes for the shift.", "maxLength": 1000, "nullable": true}, "is_deleted": {"type": "boolean", "description": "Indicates whether the draft shift version is deleted. If set to `true` when the shift\nis published, the entire scheduled shift (including the published shift) is deleted and\ncannot be accessed using any endpoint.", "nullable": true}, "timezone": {"type": "string", "description": "The time zone of the shift location, calculated based on the `location_id`. This field\nis provided for convenience.", "readOnly": true}}}, "published_shift_details": {"type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift),\nsuch as job ID, team member assignment, and start and end times.", "x-release-status": "BETA", "properties": {"team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) scheduled for the shift.", "maxLength": 255, "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) the shift is scheduled for.", "maxLength": 255, "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) the shift is scheduled for.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "end_at": {"type": "string", "description": "The end time for the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "notes": {"type": "string", "description": "Optional notes for the shift.", "maxLength": 1000, "nullable": true}, "is_deleted": {"type": "boolean", "description": "Indicates whether the draft shift version is deleted. If set to `true` when the shift\nis published, the entire scheduled shift (including the published shift) is deleted and\ncannot be accessed using any endpoint.", "nullable": true}, "timezone": {"type": "string", "description": "The time zone of the shift location, calculated based on the `location_id`. This field\nis provided for convenience.", "readOnly": true}}}, "version": {"type": "integer", "description": "**Read only** The current version of the scheduled shift, which is incremented with each update.\nThis field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol to ensure that requests don\'t overwrite data from another request."}, "created_at": {"type": "string", "description": "The timestamp of when the scheduled shift was created, in RFC 3339 format presented as UTC.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp of when the scheduled shift was last updated, in RFC 3339 format presented as UTC.", "readOnly": true}}}}, "example": {"idempotency_key": "HIDSNG5KS478L", "scheduled_shift": {"draft_shift_details": {"end_at": "2019-01-25T13:11:00-05:00", "is_deleted": false, "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", "location_id": "PAA1RJZZKXBFG", "notes": "Dont forget to prep the vegetables", "start_at": "2019-01-25T03:11:00-05:00", "team_member_id": "ormj0jJJZ5OZIzxrZYJI"}}}}',  # noqa: E501
    "BULKPUBLISHSCHEDULEDSHIFTS": '{"type": "object", "description": "Represents a [BulkPublishScheduledShifts](api-endpoint:Labor-BulkPublishScheduledShifts) request.", "x-release-status": "BETA", "required": ["scheduled_shifts"], "properties": {"scheduled_shifts": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents options for an individual publish request in a\n[BulkPublishScheduledShifts](api-endpoint:Labor-BulkPublishScheduledShifts)\noperation, provided as the value in a key-value pair.", "x-release-status": "BETA", "properties": {"version": {"type": "integer", "description": "The current version of the scheduled shift, used to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol. If the provided version doesn\'t match the server version, the request fails.\nIf omitted, Square executes a blind write, potentially overwriting data from another publish request."}}}, "description": "A map of 1 to 100 key-value pairs that represent individual publish requests.\n\n- Each key is the ID of a scheduled shift you want to publish.\n- Each value is a `BulkPublishScheduledShiftsData` object that contains the\n`version` field or is an empty object."}, "scheduled_shift_notification_audience": {"type": "string", "enum": ["ALL", "AFFECTED", "NONE"], "x-enum-elements": [{"name": "ALL", "description": "Notify all active team members. Note that republishing an unchanged\nshift with this setting resends the notification."}, {"name": "AFFECTED", "description": "Notify the team member assigned to the shift. If the shift assignment\nchanges, notify both the newly assigned and previously assigned team members."}, {"name": "NONE", "description": "Do not send a notification."}], "description": "Indicates whether Square sends an email notification to team members\nwhen a scheduled shift is published and which team members receive the notification.", "x-release-status": "BETA"}}, "example": {"scheduled-shifts": {"K0YH4CV5462JB": {"version": 3}, "scheduled-shift-2": {"version": 2}}, "scheduled_shift_notification_audience": "AFFECTED"}}',  # noqa: E501
    "LISTSCHEDULEDSHIFTS": '{"type": "object", "description": "Represents a [SearchScheduledShift](api-endpoint:Labor-SearchScheduledShift) request.", "x-release-status": "BETA", "properties": {"query": {"type": "object", "description": "Represents filter and sort criteria for the `query` field in a\n[SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request.", "x-release-status": "BETA", "properties": {"filter": {"type": "object", "description": "Defines filter criteria for a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts)\nrequest. Multiple filters in a query are combined as an `AND` operation.", "x-release-status": "BETA", "properties": {"location_ids": {"type": "array", "items": {"type": "string"}, "description": "Return shifts for the specified locations. When omitted, shifts for all\nlocations are returned. If needed, call [ListLocations](api-endpoint:Locations-ListLocations)\nto get location IDs.", "nullable": true}, "start": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "end": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "workday": {"type": "object", "description": "A `ScheduledShift` search query filter parameter that sets a range of days that\na `Shift` must start or end in before passing the filter condition.", "x-release-status": "BETA", "properties": {"date_range": {"type": "object", "description": "A range defined by two dates. Used for filtering a query for Connect v2\nobjects that have date properties.", "x-release-status": "PUBLIC", "properties": {"start_date": {"type": "string", "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe beginning of a date range (inclusive).", "nullable": true}, "end_date": {"type": "string", "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe end of a date range (inclusive).", "nullable": true}}}, "match_scheduled_shifts_by": {"type": "string", "enum": ["START_AT", "END_AT", "INTERSECTION"], "x-enum-elements": [{"name": "START_AT", "description": "All shifts that start on or after the specified workday"}, {"name": "END_AT", "description": "All shifts that end on or before the specified workday"}, {"name": "INTERSECTION", "description": "All shifts that start between the start and end workdays (inclusive)"}], "description": "Defines the logic used to apply a workday filter.", "x-release-status": "BETA"}, "default_timezone": {"type": "string", "description": "Location-specific timezones convert workdays to datetime filters.\nEvery location included in the query must have a timezone or this field\nmust be provided as a fallback. Format: the IANA timezone database\nidentifier for the relevant timezone.", "nullable": true}}}, "team_member_ids": {"type": "array", "items": {"type": "string"}, "description": "Return shifts assigned to specified team members. If needed, call\n[SearchTeamMembers](api-endpoint:Team-SearchTeamMembers) to get team member IDs.\n\nTo return only the shifts assigned to the specified team members, include the\n`assignment_status` filter in the query. Otherwise, all unassigned shifts are\nreturned along with shifts assigned to the specified team members.", "nullable": true}, "assignment_status": {"type": "string", "enum": ["ASSIGNED", "UNASSIGNED"], "x-enum-elements": [{"name": "ASSIGNED", "description": "The shift is assigned to a team member."}, {"name": "UNASSIGNED", "description": "The shift isn\'t assigned to a team member."}], "description": "Defines valid values for the `assignment_status` filter in a\n[SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request.\nAssignment status is based on the `draft_shift_details.team_member_id` and\n`published_shift_details.team_member_id` fields of the scheduled shift.", "x-release-status": "BETA"}, "scheduled_shift_statuses": {"type": "array", "items": {"type": "string", "enum": ["DRAFT", "PUBLISHED"], "x-enum-elements": [{"name": "DRAFT", "description": "The scheduled shift has never been published or its draft details were\nupdated after it was published. This means that the shift has no `published_shift_details`\nfield or that `draft_shift_details` has different settings than `published_shift_details`."}, {"name": "PUBLISHED", "description": "The scheduled shift was published. This means that the shift has a\n`published_shift_details` field."}], "description": "Defines valid values for the `scheduled_shift_statuses` filter in a\n[SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request.", "x-release-status": "BETA"}, "description": "Return shifts based on the draft or published status of the shift.\nA shift is published if the `published_shift_details` field is present.\n\nNote that shifts with `draft_shift_details.is_deleted` set to `true` are ignored\nwith the `DRAFT` filter.\nSee [ScheduledShiftFilterScheduledShiftStatus](#type-scheduledshiftfilterscheduledshiftstatus) for possible values", "nullable": true}}}, "sort": {"type": "object", "description": "Defines sort criteria for a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts)\nrequest.", "x-release-status": "BETA", "properties": {"field": {"type": "string", "enum": ["START_AT", "END_AT", "CREATED_AT", "UPDATED_AT"], "x-enum-elements": [{"name": "START_AT", "description": "Sort by the start time of the shift."}, {"name": "END_AT", "description": "Sort by the end time of the shift."}, {"name": "CREATED_AT", "description": "Sort by the creation date of the shift."}, {"name": "UPDATED_AT", "description": "Sort by the last updated date of the shift."}], "description": "Defines valid values for the `field` sort setting in a\n[SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request.", "x-release-status": "BETA"}, "order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}}}}}, "limit": {"type": "integer", "description": "The maximum number of results to return in a single response page. The default value is 50.", "minimum": 1, "maximum": 50}, "cursor": {"type": "string", "description": "The pagination cursor returned by the previous call to this endpoint. Provide\nthis cursor to retrieve the next page of results for your original request. For more\ninformation, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."}}, "example": {"cursor": "xoxp-1234-5678-90123", "limit": 2, "query": {"filter": {"assignment_status": "ASSIGNED", "scheduled_shift_status": ["PUBLISHED", "DRAFT"]}, "sort": {"field": "CREATED_AT", "order": "ASC"}}}}',  # noqa: E501
    "UPDATESCHEDULEDSHIFT": '{"type": "object", "x-release-status": "BETA", "required": ["scheduled_shift"], "properties": {"scheduled_shift": {"type": "object", "description": "Represents a specific time slot in a work schedule. This object is used to manage the\nlifecycle of a scheduled shift from the draft to published state. A scheduled shift contains\nthe latest draft shift details and current published shift details.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "**Read only** The Square-issued ID of the scheduled shift.", "maxLength": 255}, "draft_shift_details": {"type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift),\nsuch as job ID, team member assignment, and start and end times.", "x-release-status": "BETA", "properties": {"team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) scheduled for the shift.", "maxLength": 255, "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) the shift is scheduled for.", "maxLength": 255, "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) the shift is scheduled for.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "end_at": {"type": "string", "description": "The end time for the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "notes": {"type": "string", "description": "Optional notes for the shift.", "maxLength": 1000, "nullable": true}, "is_deleted": {"type": "boolean", "description": "Indicates whether the draft shift version is deleted. If set to `true` when the shift\nis published, the entire scheduled shift (including the published shift) is deleted and\ncannot be accessed using any endpoint.", "nullable": true}, "timezone": {"type": "string", "description": "The time zone of the shift location, calculated based on the `location_id`. This field\nis provided for convenience.", "readOnly": true}}}, "published_shift_details": {"type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift),\nsuch as job ID, team member assignment, and start and end times.", "x-release-status": "BETA", "properties": {"team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) scheduled for the shift.", "maxLength": 255, "nullable": true}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) the shift is scheduled for.", "maxLength": 255, "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) the shift is scheduled for.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "end_at": {"type": "string", "description": "The end time for the shift, in RFC 3339 format in the time zone &plus;\noffset of the shift location specified in `location_id`. Precision up to the minute\nis respected; seconds are truncated.", "nullable": true}, "notes": {"type": "string", "description": "Optional notes for the shift.", "maxLength": 1000, "nullable": true}, "is_deleted": {"type": "boolean", "description": "Indicates whether the draft shift version is deleted. If set to `true` when the shift\nis published, the entire scheduled shift (including the published shift) is deleted and\ncannot be accessed using any endpoint.", "nullable": true}, "timezone": {"type": "string", "description": "The time zone of the shift location, calculated based on the `location_id`. This field\nis provided for convenience.", "readOnly": true}}}, "version": {"type": "integer", "description": "**Read only** The current version of the scheduled shift, which is incremented with each update.\nThis field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol to ensure that requests don\'t overwrite data from another request."}, "created_at": {"type": "string", "description": "The timestamp of when the scheduled shift was created, in RFC 3339 format presented as UTC.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp of when the scheduled shift was last updated, in RFC 3339 format presented as UTC.", "readOnly": true}}}}, "example": {"scheduled_shift": {"draft_shift_details": {"end_at": "2019-03-25T13:18:00-05:00", "is_deleted": false, "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M", "location_id": "PAA1RJZZKXBFG", "notes": "Dont forget to prep the vegetables", "start_at": "2019-03-25T03:11:00-05:00", "team_member_id": "ormj0jJJZ5OZIzxrZYJI"}, "version": 1}}}',  # noqa: E501
    "CREATETEAMMEMBERTIMECARD": '{"type": "object", "description": "Represents a request to create a `Timecard`.", "x-release-status": "PUBLIC", "required": ["timecard"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string value to ensure the idempotency of the operation.", "maxLength": 128}, "timecard": {"type": "object", "description": "A record of the hourly rate, start time, and end time of a single timecard (shift)\nfor a team member. This might include a record of the start and end times of breaks\ntaken during the shift.", "x-release-status": "PUBLIC", "required": ["location_id", "start_at", "team_member_id"], "properties": {"id": {"type": "string", "description": "**Read only** The Square-issued UUID for this object.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) for this timecard. The location should be based on\nwhere the team member clocked in.", "minLength": 1}, "timezone": {"type": "string", "description": "**Read only** The time zone calculated from the location based on the `location_id`,\nprovided as a convenience value. Format: the IANA time zone database identifier for the\nlocation time zone.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the timecard, in RFC 3339 format and shifted to the location\ntimezone + offset. Precision up to the minute is respected; seconds are truncated.", "minLength": 1}, "end_at": {"type": "string", "description": "The end time of the timecard, in RFC 3339 format and shifted to the location\ntimezone + offset. Precision up to the minute is respected; seconds are truncated.", "nullable": true}, "wage": {"type": "object", "description": "The hourly wage rate used to compensate a team member for a [timecard](entity:Timecard).", "x-release-status": "PUBLIC", "properties": {"title": {"type": "string", "description": "The name of the job performed during this timecard.", "nullable": true}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) performed for this timecard. Square\nlabor-reporting UIs might group timecards together by ID.", "readOnly": true}, "tip_eligible": {"type": "boolean", "description": "Whether team members are eligible for tips when working this job.", "nullable": true}}}, "breaks": {"type": "array", "items": {"type": "object", "description": "A record of a team member\'s break on a [timecard](entity:Timecard).", "x-release-status": "PUBLIC", "required": ["start_at", "break_type_id", "name", "expected_duration", "is_paid"], "properties": {"id": {"type": "string", "description": "The UUID for this object."}, "start_at": {"type": "string", "description": "RFC 3339; follows the same timezone information as the [timecard](entity:Timecard). Precision up to\nthe minute is respected; seconds are truncated.", "minLength": 1}, "end_at": {"type": "string", "description": "RFC 3339; follows the same timezone information as the [timecard](entity:Timecard). Precision up to\nthe minute is respected; seconds are truncated.", "nullable": true}, "break_type_id": {"type": "string", "description": "The [BreakType](entity:BreakType) that this break was templated on.", "minLength": 1}, "name": {"type": "string", "description": "A human-readable name.", "minLength": 1}, "expected_duration": {"type": "string", "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthe break.\n\nExample for break expected duration of 15 minutes: PT15M", "minLength": 1}, "is_paid": {"type": "boolean", "description": "Whether this break counts towards time worked for compensation\npurposes."}}}, "description": "A list of all the paid or unpaid breaks that were taken during this timecard.", "nullable": true}, "status": {"type": "string", "enum": ["OPEN", "CLOSED"], "x-enum-elements": [{"name": "OPEN", "description": "The timecard has a `start_at` time but no `end_at` time, indicating an ongoing shift."}, {"name": "CLOSED", "description": "The timecard has both `start_at` and `end_at` times, indicating a completed shift."}], "description": "**Read only** Enumerates the possible status of a [timecard](entity:Timecard).", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "**Read only** The current version of the timecard, which is incremented with each update.\nThis field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol to ensure that requests don\'t overwrite data from another request."}, "created_at": {"type": "string", "description": "The timestamp of when the timecard was created, in RFC 3339 format presented as UTC.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp of when the timecard was last updated, in RFC 3339 format presented as UTC.", "readOnly": true}, "team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) this timecard belongs to.", "minLength": 1}, "declared_cash_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}, "example": {"idempotency_key": "HIDSNG5KS478L", "timecard": {"breaks": [{"break_type_id": "REGS1EQR1TPZ5", "end_at": "2019-01-25T06:16:00-05:00", "expected_duration": "PT5M", "is_paid": true, "name": "Tea Break", "start_at": "2019-01-25T06:11:00-05:00"}], "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, "end_at": "2019-01-25T13:11:00-05:00", "location_id": "PAA1RJZZKXBFG", "start_at": "2019-01-25T03:11:00-05:00", "team_member_id": "ormj0jJJZ5OZIzxrZYJI", "wage": {"hourly_rate": {"amount": 1100, "currency": "USD"}, "tip_eligible": true, "title": "Barista"}}}}',  # noqa: E501
    "SEARCHTIMECARDS": '{"type": "object", "description": "A request for a filtered and sorted set of `Timecard` objects.", "x-release-status": "PUBLIC", "properties": {"query": {"type": "object", "description": "The parameters of a `Timecard` search query, which includes filter and sort options.", "x-release-status": "PUBLIC", "properties": {"filter": {"type": "object", "description": "Defines a filter used in a search for `Timecard` records. `AND` logic is\nused by Square\'s servers to apply each filter property specified.", "x-release-status": "PUBLIC", "properties": {"location_ids": {"type": "array", "items": {"type": "string"}, "description": "Fetch timecards for the specified location.", "nullable": true}, "status": {"type": "string", "enum": ["OPEN", "CLOSED"], "x-enum-elements": [{"name": "OPEN", "description": "Timecards that have been started and not ended."}, {"name": "CLOSED", "description": "Timecards that have been started and ended."}], "description": "Specifies the `status` of `Timecard` records to be returned.", "x-release-status": "PUBLIC"}, "start": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "end": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "workday": {"type": "object", "description": "A `Timecard` search query filter parameter that sets a range of days that\na `Timecard` must start or end in before passing the filter condition.", "x-release-status": "PUBLIC", "properties": {"date_range": {"type": "object", "description": "A range defined by two dates. Used for filtering a query for Connect v2\nobjects that have date properties.", "x-release-status": "PUBLIC", "properties": {"start_date": {"type": "string", "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe beginning of a date range (inclusive).", "nullable": true}, "end_date": {"type": "string", "description": "A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601\nextended format for calendar dates.\nThe end of a date range (inclusive).", "nullable": true}}}, "match_timecards_by": {"type": "string", "enum": ["START_AT", "END_AT", "INTERSECTION"], "x-enum-elements": [{"name": "START_AT", "description": "All timecards that start on or after the specified workday"}, {"name": "END_AT", "description": "All timecards that end on or before the specified workday"}, {"name": "INTERSECTION", "description": "All timecards that start between the start and end workdays (inclusive)"}], "description": "Defines the logic used to apply a workday filter.", "x-release-status": "PUBLIC"}, "default_timezone": {"type": "string", "description": "Location-specific timezones convert workdays to datetime filters.\nEvery location included in the query must have a timezone or this field\nmust be provided as a fallback. Format: the IANA timezone database\nidentifier for the relevant timezone.", "nullable": true}}}, "team_member_ids": {"type": "array", "items": {"type": "string"}, "description": "Fetch timecards for the specified team members.", "nullable": true}}}, "sort": {"type": "object", "description": "Sets the sort order of search results.", "x-release-status": "PUBLIC", "properties": {"field": {"type": "string", "enum": ["START_AT", "END_AT", "CREATED_AT", "UPDATED_AT"], "x-enum-elements": [{"name": "START_AT", "description": "The start date/time of a `Timecard`"}, {"name": "END_AT", "description": "The end date/time of a `Timecard`"}, {"name": "CREATED_AT", "description": "The date/time that a `Timecard` is created"}, {"name": "UPDATED_AT", "description": "The most recent date/time that a `Timecard` is updated"}], "description": "Enumerates the `Timecard` fields to sort on.", "x-release-status": "PUBLIC"}, "order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}}}}}, "limit": {"type": "integer", "description": "The number of resources in a page (200 by default).", "minimum": 1, "maximum": 200}, "cursor": {"type": "string", "description": "An opaque cursor for fetching the next page."}}, "example": {"limit": 100, "query": {"filter": {"workday": {"date_range": {"end_date": "2019-02-03", "start_date": "2019-01-20"}, "default_timezone": "America/Los_Angeles", "match_timecards_by": "START_AT"}}}}}',  # noqa: E501
    "UPDATETIMECARD": '{"type": "object", "description": "A request to update a `Timecard` object.", "x-release-status": "PUBLIC", "required": ["timecard"], "properties": {"timecard": {"type": "object", "description": "A record of the hourly rate, start time, and end time of a single timecard (shift)\nfor a team member. This might include a record of the start and end times of breaks\ntaken during the shift.", "x-release-status": "PUBLIC", "required": ["location_id", "start_at", "team_member_id"], "properties": {"id": {"type": "string", "description": "**Read only** The Square-issued UUID for this object.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the [location](entity:Location) for this timecard. The location should be based on\nwhere the team member clocked in.", "minLength": 1}, "timezone": {"type": "string", "description": "**Read only** The time zone calculated from the location based on the `location_id`,\nprovided as a convenience value. Format: the IANA time zone database identifier for the\nlocation time zone.", "nullable": true}, "start_at": {"type": "string", "description": "The start time of the timecard, in RFC 3339 format and shifted to the location\ntimezone + offset. Precision up to the minute is respected; seconds are truncated.", "minLength": 1}, "end_at": {"type": "string", "description": "The end time of the timecard, in RFC 3339 format and shifted to the location\ntimezone + offset. Precision up to the minute is respected; seconds are truncated.", "nullable": true}, "wage": {"type": "object", "description": "The hourly wage rate used to compensate a team member for a [timecard](entity:Timecard).", "x-release-status": "PUBLIC", "properties": {"title": {"type": "string", "description": "The name of the job performed during this timecard.", "nullable": true}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job) performed for this timecard. Square\nlabor-reporting UIs might group timecards together by ID.", "readOnly": true}, "tip_eligible": {"type": "boolean", "description": "Whether team members are eligible for tips when working this job.", "nullable": true}}}, "breaks": {"type": "array", "items": {"type": "object", "description": "A record of a team member\'s break on a [timecard](entity:Timecard).", "x-release-status": "PUBLIC", "required": ["start_at", "break_type_id", "name", "expected_duration", "is_paid"], "properties": {"id": {"type": "string", "description": "The UUID for this object."}, "start_at": {"type": "string", "description": "RFC 3339; follows the same timezone information as the [timecard](entity:Timecard). Precision up to\nthe minute is respected; seconds are truncated.", "minLength": 1}, "end_at": {"type": "string", "description": "RFC 3339; follows the same timezone information as the [timecard](entity:Timecard). Precision up to\nthe minute is respected; seconds are truncated.", "nullable": true}, "break_type_id": {"type": "string", "description": "The [BreakType](entity:BreakType) that this break was templated on.", "minLength": 1}, "name": {"type": "string", "description": "A human-readable name.", "minLength": 1}, "expected_duration": {"type": "string", "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of\nthe break.\n\nExample for break expected duration of 15 minutes: PT15M", "minLength": 1}, "is_paid": {"type": "boolean", "description": "Whether this break counts towards time worked for compensation\npurposes."}}}, "description": "A list of all the paid or unpaid breaks that were taken during this timecard.", "nullable": true}, "status": {"type": "string", "enum": ["OPEN", "CLOSED"], "x-enum-elements": [{"name": "OPEN", "description": "The timecard has a `start_at` time but no `end_at` time, indicating an ongoing shift."}, {"name": "CLOSED", "description": "The timecard has both `start_at` and `end_at` times, indicating a completed shift."}], "description": "**Read only** Enumerates the possible status of a [timecard](entity:Timecard).", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "**Read only** The current version of the timecard, which is incremented with each update.\nThis field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)\ncontrol to ensure that requests don\'t overwrite data from another request."}, "created_at": {"type": "string", "description": "The timestamp of when the timecard was created, in RFC 3339 format presented as UTC.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp of when the timecard was last updated, in RFC 3339 format presented as UTC.", "readOnly": true}, "team_member_id": {"type": "string", "description": "The ID of the [team member](entity:TeamMember) this timecard belongs to.", "minLength": 1}, "declared_cash_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}, "example": {"idempotency_key": "HIDSNG5KS478L", "timecard": {"breaks": [{"break_type_id": "REGS1EQR1TPZ5", "end_at": "2019-01-25T06:16:00-05:00", "expected_duration": "PT5M", "id": "X7GAQYVVRRG6P", "is_paid": true, "name": "Tea Break", "start_at": "2019-01-25T06:11:00-05:00"}], "declared_cash_tip_money": {"amount": 500, "currency": "USD"}, "end_at": "2019-01-25T13:11:00-05:00", "location_id": "PAA1RJZZKXBFG", "start_at": "2019-01-25T03:11:00-05:00", "status": "CLOSED", "team_member_id": "ormj0jJJZ5OZIzxrZYJI", "version": 1, "wage": {"hourly_rate": {"amount": 1500, "currency": "USD"}, "tip_eligible": true, "title": "Bartender"}}}}',  # noqa: E501
    "CREATENEWLOCATION": '{"type": "object", "description": "The request object for the [CreateLocation](api-endpoint:Locations-CreateLocation) endpoint.", "x-release-status": "PUBLIC", "properties": {"location": {"type": "object", "description": "Represents one of a business\' [locations](https://developer.squareup.com/docs/locations-api).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A short generated string of letters and numbers that uniquely identifies this location instance.", "maxLength": 32, "readOnly": true}, "name": {"type": "string", "description": "The name of the location.\nThis information appears in the Seller Dashboard as the nickname.\nA location name must be unique within a seller account.", "maxLength": 255, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "timezone": {"type": "string", "description": "The [IANA time zone](https://www.iana.org/time-zones) identifier for\nthe time zone of the location. For example, `America/Los_Angeles`.", "maxLength": 30, "nullable": true}, "capabilities": {"type": "array", "items": {"type": "string", "enum": ["CREDIT_CARD_PROCESSING", "AUTOMATIC_TRANSFERS", "UNLINKED_REFUNDS"], "x-enum-elements": [{"name": "CREDIT_CARD_PROCESSING", "description": "The capability to process credit card transactions with Square."}, {"name": "AUTOMATIC_TRANSFERS", "description": "The capability to receive automatic transfers from Square."}, {"name": "UNLINKED_REFUNDS", "description": "The capability to process unlinked refunds with Square."}], "description": "The capabilities a location might have.", "x-release-status": "PUBLIC"}, "description": "The Square features that are enabled for the location.\nSee [LocationCapability](entity:LocationCapability) for possible values.\nSee [LocationCapability](#type-locationcapability) for possible values", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "A location that is active for business."}, {"name": "INACTIVE", "description": "A location that is not active for business. Inactive locations provide historical\ninformation. Hide inactive locations unless the user has requested to see them."}], "description": "A location\'s status.", "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The time when the location was created, in RFC 3339 format.\nFor more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).", "minLength": 20, "maxLength": 25, "readOnly": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant that owns the location.", "maxLength": 32, "readOnly": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "language_code": {"type": "string", "description": "The language associated with the location, in\n[BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).\nFor more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).", "minLength": 2, "maxLength": 5, "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}, "phone_number": {"type": "string", "description": "The phone number of the location. For example, `+1 855-700-6000`.", "maxLength": 17, "nullable": true}, "business_name": {"type": "string", "description": "The name of the location\'s overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["PHYSICAL", "MOBILE"], "x-enum-elements": [{"name": "PHYSICAL", "description": "A place of business with a physical location."}, {"name": "MOBILE", "description": "A place of business that is mobile, such as a food truck or online store."}], "description": "A location\'s type.", "x-release-status": "PUBLIC"}, "website_url": {"type": "string", "description": "The website URL of the location.  For example, `https://squareup.com`.", "maxLength": 255, "nullable": true}, "business_hours": {"type": "object", "description": "The hours of operation for a location.", "x-release-status": "PUBLIC", "properties": {"periods": {"type": "array", "items": {"type": "object", "description": "Represents a period of time during which a business location is open.", "x-release-status": "PUBLIC", "properties": {"day_of_week": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"], "x-enum-elements": [{"name": "SUN", "description": "Sunday"}, {"name": "MON", "description": "Monday"}, {"name": "TUE", "description": "Tuesday"}, {"name": "WED", "description": "Wednesday"}, {"name": "THU", "description": "Thursday"}, {"name": "FRI", "description": "Friday"}, {"name": "SAT", "description": "Saturday"}], "description": "Indicates the specific day  of the week.", "x-release-status": "PUBLIC"}, "start_local_time": {"type": "string", "description": "The start time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "end_local_time": {"type": "string", "description": "The end time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}}}, "description": "The list of time periods during which the business is open. There can be at most 10 periods per day.", "nullable": true}}}, "business_email": {"type": "string", "description": "The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "The description of the location. For example, `Main Street location`.", "maxLength": 1024, "nullable": true}, "twitter_username": {"type": "string", "description": "The Twitter username of the location without the \'@\' symbol. For example, `Square`.", "minLength": 1, "maxLength": 15, "nullable": true}, "instagram_username": {"type": "string", "description": "The Instagram username of the location without the \'@\' symbol. For example, `square`.", "minLength": 1, "maxLength": 30, "nullable": true}, "facebook_url": {"type": "string", "description": "The Facebook profile URL of the location. The URL should begin with \'facebook.com/\'. For example, `https://www.facebook.com/square`.", "maxLength": 255, "nullable": true}, "coordinates": {"type": "object", "description": "Latitude and longitude coordinates.", "x-release-status": "PUBLIC", "properties": {"latitude": {"type": "number", "description": "The latitude of the coordinate expressed in degrees.", "nullable": true}, "longitude": {"type": "number", "description": "The longitude of the coordinate expressed in degrees.", "nullable": true}}}, "logo_url": {"type": "string", "description": "The URL of the logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.", "maxLength": 255, "readOnly": true}, "pos_background_url": {"type": "string", "description": "The URL of the Point of Sale background image for the location.", "maxLength": 255, "readOnly": true}, "mcc": {"type": "string", "description": "A four-digit number that describes the kind of goods or services sold at the location.\nThe [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245.\nFor example, `5045`, for a location that sells computer goods and software.", "minLength": 4, "maxLength": 4, "x-release-status": "BETA", "nullable": true}, "full_format_logo_url": {"type": "string", "description": "The URL of a full-format logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image can be wider than it is tall and should be at least 1280x648 pixels.", "readOnly": true}, "tax_ids": {"type": "object", "description": "Identifiers for the location used by various governments for tax purposes.", "x-release-status": "BETA", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT number for this location. For example, `IE3426675K`.\nIf the EU VAT number is present, it is well-formed and has been\nvalidated with VIES, the VAT Information Exchange System.", "readOnly": true}, "fr_siret": {"type": "string", "description": "The SIRET (Syst\u00e8me d\'Identification du R\u00e9pertoire des Entreprises et de leurs Etablissements)\nnumber is a 14-digit code issued by the French INSEE. For example, `39922799000021`.", "readOnly": true}, "fr_naf": {"type": "string", "description": "The French government uses the NAF (Nomenclature des Activit\u00e9s Fran\u00e7aises) to display and\ntrack economic statistical data. This is also called the APE (Activite Principale de l\u2019Entreprise) code.\nFor example, `6910Z`.", "readOnly": true}, "es_nif": {"type": "string", "description": "The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain.\nIf it is present, it has been validated. For example, `73628495A`.", "readOnly": true}, "jp_qii": {"type": "string", "description": "The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan.\nFor example, `T1234567890123`.", "readOnly": true}}}}}}, "example": {"location": {"address": {"address_line_1": "1234 Peachtree St. NE", "administrative_district_level_1": "GA", "locality": "Atlanta", "postal_code": "30309"}, "description": "Midtown Atlanta store", "name": "Midtown"}}}',  # noqa: E501
    "BULKDELETELOCATIONCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes) request.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkDeleteLocationCustomAttributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "properties": {"key": {"type": "string", "description": "The key of the associated custom attribute definition.\nRepresented as a qualified key if the requesting app is not the definition owner.", "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", "readOnly": true}}}, "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response."}}, "example": {"values": {"id1": {"key": "bestseller", "location_id": "L0TBCBTB7P8RQ"}, "id2": {"key": "bestseller", "location_id": "L9XMD04V3STJX"}, "id3": {"key": "phone-number", "location_id": "L0TBCBTB7P8RQ"}}}}',  # noqa: E501
    "BULKUPSERTLOCATIONCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes) request.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes)\nrequest. An individual request contains a location ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "required": ["location_id", "custom_attribute"], "properties": {"location_id": {"type": "string", "description": "The ID of the target [location](entity:Location).", "minLength": 1}, "custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}}, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the\ninformation needed to create or update a custom attribute."}}, "example": {"values": {"id1": {"custom_attribute": {"key": "bestseller", "value": "hot cocoa"}, "location_id": "L0TBCBTB7P8RQ"}, "id2": {"custom_attribute": {"key": "bestseller", "value": "berry smoothie"}, "location_id": "L9XMD04V3STJX"}, "id3": {"custom_attribute": {"key": "phone-number", "value": "+12223334444"}, "location_id": "L0TBCBTB7P8RQ"}}}}',  # noqa: E501
    "UPDATELOCATIONSQUAREUP": '{"type": "object", "description": "The request object for the [UpdateLocation](api-endpoint:Locations-UpdateLocation) endpoint.", "x-release-status": "PUBLIC", "properties": {"location": {"type": "object", "description": "Represents one of a business\' [locations](https://developer.squareup.com/docs/locations-api).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A short generated string of letters and numbers that uniquely identifies this location instance.", "maxLength": 32, "readOnly": true}, "name": {"type": "string", "description": "The name of the location.\nThis information appears in the Seller Dashboard as the nickname.\nA location name must be unique within a seller account.", "maxLength": 255, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "timezone": {"type": "string", "description": "The [IANA time zone](https://www.iana.org/time-zones) identifier for\nthe time zone of the location. For example, `America/Los_Angeles`.", "maxLength": 30, "nullable": true}, "capabilities": {"type": "array", "items": {"type": "string", "enum": ["CREDIT_CARD_PROCESSING", "AUTOMATIC_TRANSFERS", "UNLINKED_REFUNDS"], "x-enum-elements": [{"name": "CREDIT_CARD_PROCESSING", "description": "The capability to process credit card transactions with Square."}, {"name": "AUTOMATIC_TRANSFERS", "description": "The capability to receive automatic transfers from Square."}, {"name": "UNLINKED_REFUNDS", "description": "The capability to process unlinked refunds with Square."}], "description": "The capabilities a location might have.", "x-release-status": "PUBLIC"}, "description": "The Square features that are enabled for the location.\nSee [LocationCapability](entity:LocationCapability) for possible values.\nSee [LocationCapability](#type-locationcapability) for possible values", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "A location that is active for business."}, {"name": "INACTIVE", "description": "A location that is not active for business. Inactive locations provide historical\ninformation. Hide inactive locations unless the user has requested to see them."}], "description": "A location\'s status.", "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The time when the location was created, in RFC 3339 format.\nFor more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).", "minLength": 20, "maxLength": 25, "readOnly": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant that owns the location.", "maxLength": 32, "readOnly": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "language_code": {"type": "string", "description": "The language associated with the location, in\n[BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).\nFor more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).", "minLength": 2, "maxLength": 5, "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}, "phone_number": {"type": "string", "description": "The phone number of the location. For example, `+1 855-700-6000`.", "maxLength": 17, "nullable": true}, "business_name": {"type": "string", "description": "The name of the location\'s overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["PHYSICAL", "MOBILE"], "x-enum-elements": [{"name": "PHYSICAL", "description": "A place of business with a physical location."}, {"name": "MOBILE", "description": "A place of business that is mobile, such as a food truck or online store."}], "description": "A location\'s type.", "x-release-status": "PUBLIC"}, "website_url": {"type": "string", "description": "The website URL of the location.  For example, `https://squareup.com`.", "maxLength": 255, "nullable": true}, "business_hours": {"type": "object", "description": "The hours of operation for a location.", "x-release-status": "PUBLIC", "properties": {"periods": {"type": "array", "items": {"type": "object", "description": "Represents a period of time during which a business location is open.", "x-release-status": "PUBLIC", "properties": {"day_of_week": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"], "x-enum-elements": [{"name": "SUN", "description": "Sunday"}, {"name": "MON", "description": "Monday"}, {"name": "TUE", "description": "Tuesday"}, {"name": "WED", "description": "Wednesday"}, {"name": "THU", "description": "Thursday"}, {"name": "FRI", "description": "Friday"}, {"name": "SAT", "description": "Saturday"}], "description": "Indicates the specific day  of the week.", "x-release-status": "PUBLIC"}, "start_local_time": {"type": "string", "description": "The start time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}, "end_local_time": {"type": "string", "description": "The end time of a business hours period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC.", "nullable": true}}}, "description": "The list of time periods during which the business is open. There can be at most 10 periods per day.", "nullable": true}}}, "business_email": {"type": "string", "description": "The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "The description of the location. For example, `Main Street location`.", "maxLength": 1024, "nullable": true}, "twitter_username": {"type": "string", "description": "The Twitter username of the location without the \'@\' symbol. For example, `Square`.", "minLength": 1, "maxLength": 15, "nullable": true}, "instagram_username": {"type": "string", "description": "The Instagram username of the location without the \'@\' symbol. For example, `square`.", "minLength": 1, "maxLength": 30, "nullable": true}, "facebook_url": {"type": "string", "description": "The Facebook profile URL of the location. The URL should begin with \'facebook.com/\'. For example, `https://www.facebook.com/square`.", "maxLength": 255, "nullable": true}, "coordinates": {"type": "object", "description": "Latitude and longitude coordinates.", "x-release-status": "PUBLIC", "properties": {"latitude": {"type": "number", "description": "The latitude of the coordinate expressed in degrees.", "nullable": true}, "longitude": {"type": "number", "description": "The longitude of the coordinate expressed in degrees.", "nullable": true}}}, "logo_url": {"type": "string", "description": "The URL of the logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.", "maxLength": 255, "readOnly": true}, "pos_background_url": {"type": "string", "description": "The URL of the Point of Sale background image for the location.", "maxLength": 255, "readOnly": true}, "mcc": {"type": "string", "description": "A four-digit number that describes the kind of goods or services sold at the location.\nThe [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245.\nFor example, `5045`, for a location that sells computer goods and software.", "minLength": 4, "maxLength": 4, "x-release-status": "BETA", "nullable": true}, "full_format_logo_url": {"type": "string", "description": "The URL of a full-format logo image for the location. When configured in the Seller\nDashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.\nThis image can be wider than it is tall and should be at least 1280x648 pixels.", "readOnly": true}, "tax_ids": {"type": "object", "description": "Identifiers for the location used by various governments for tax purposes.", "x-release-status": "BETA", "properties": {"eu_vat": {"type": "string", "description": "The EU VAT number for this location. For example, `IE3426675K`.\nIf the EU VAT number is present, it is well-formed and has been\nvalidated with VIES, the VAT Information Exchange System.", "readOnly": true}, "fr_siret": {"type": "string", "description": "The SIRET (Syst\u00e8me d\'Identification du R\u00e9pertoire des Entreprises et de leurs Etablissements)\nnumber is a 14-digit code issued by the French INSEE. For example, `39922799000021`.", "readOnly": true}, "fr_naf": {"type": "string", "description": "The French government uses the NAF (Nomenclature des Activit\u00e9s Fran\u00e7aises) to display and\ntrack economic statistical data. This is also called the APE (Activite Principale de l\u2019Entreprise) code.\nFor example, `6910Z`.", "readOnly": true}, "es_nif": {"type": "string", "description": "The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain.\nIf it is present, it has been validated. For example, `73628495A`.", "readOnly": true}, "jp_qii": {"type": "string", "description": "The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan.\nFor example, `T1234567890123`.", "readOnly": true}}}}}}, "example": {"location": {"business_hours": {"periods": [{"day_of_week": "FRI", "end_local_time": "18:00", "start_local_time": "07:00"}, {"day_of_week": "SAT", "end_local_time": "18:00", "start_local_time": "07:00"}, {"day_of_week": "SUN", "end_local_time": "15:00", "start_local_time": "09:00"}]}, "description": "Midtown Atlanta store - Open weekends"}}}',  # noqa: E501
    "UPSERTLOCATIONCUSTOMATTRIBUTE": '{"type": "object", "description": "Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) request.", "x-release-status": "BETA", "x-params-example": "?location_id=L0TBCBTB7P8RQ&key=bestseller", "required": ["custom_attribute"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}, "example": {"custom_attribute": {"value": "hot cocoa"}}}',  # noqa: E501
    "CREATELOYALTYACCOUNT": '{"type": "object", "description": "A request to create a new loyalty account.", "x-release-status": "PUBLIC", "required": ["loyalty_account", "idempotency_key"], "properties": {"loyalty_account": {"type": "object", "description": "Describes a loyalty account in a [loyalty program](entity:LoyaltyProgram). For more information, see\n[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).", "x-release-status": "PUBLIC", "required": ["program_id"], "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the loyalty account.", "maxLength": 36, "readOnly": true}, "program_id": {"type": "string", "description": "The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs.", "minLength": 1, "maxLength": 36}, "balance": {"type": "integer", "description": "The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field.\n\nYour application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange.", "readOnly": true}, "lifetime_points": {"type": "integer", "description": "The total points accrued during the lifetime of the account.", "readOnly": true}, "customer_id": {"type": "string", "description": "The Square-assigned ID of the [customer](entity:Customer) that is associated with the account.", "nullable": true}, "enrolled_at": {"type": "string", "description": "The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products.\n\nIf this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer\'s first action on their account \n(when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service on Square Point of Sale. \n\nIf this field is set in a `CreateLoyaltyAccount` request, it is meant to be used when there is a loyalty migration from another system and into Square.\nIn that case, the timestamp can reflect when the buyer originally enrolled in the previous system. It may represent a current or past date, but cannot be set in the future.\nNote: Setting this field in this scenario does not, by itself, impact the first-party enrollment flow on Square Point of Sale.", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the loyalty account was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the loyalty account was last updated, in RFC 3339 format.", "readOnly": true}, "mapping": {"type": "object", "description": "Represents the mapping that associates a loyalty account with a buyer. \n\nCurrently, a loyalty account can only be mapped to a buyer by phone number. For more information, see \n[Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the mapping.", "maxLength": 36, "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp when the mapping was created, in RFC 3339 format.", "readOnly": true}, "phone_number": {"type": "string", "description": "The phone number of the buyer, in E.164 format. For example, "+14155551111".", "nullable": true}}}, "expiring_point_deadlines": {"type": "array", "items": {"type": "object", "description": "Represents a set of points for a loyalty account that are scheduled to expire on a specific date.", "x-release-status": "PUBLIC", "required": ["points", "expires_at"], "properties": {"points": {"type": "integer", "description": "The number of points scheduled to expire at the `expires_at` timestamp."}, "expires_at": {"type": "string", "description": "The timestamp of when the points are scheduled to expire, in RFC 3339 format.", "minLength": 1}}}, "description": "The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. \n\nThe total number of points in this field equals the number of points in the `balance` field.", "nullable": true}}}, "idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateLoyaltyAccount` request. \nKeys can be any valid string, but must be unique for every request.", "minLength": 1, "maxLength": 128}}, "example": {"idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996", "loyalty_account": {"mapping": {"phone_number": "+14155551234"}, "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd"}}}',  # noqa: E501
    "SEARCHLOYALTYACCOUNTS": '{"type": "object", "description": "A request to search for loyalty accounts.", "x-release-status": "PUBLIC", "properties": {"query": {"type": "object", "description": "The search criteria for the loyalty accounts.", "x-release-status": "PUBLIC", "properties": {"mappings": {"type": "array", "items": {"type": "object", "description": "Represents the mapping that associates a loyalty account with a buyer. \n\nCurrently, a loyalty account can only be mapped to a buyer by phone number. For more information, see \n[Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the mapping.", "maxLength": 36, "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp when the mapping was created, in RFC 3339 format.", "readOnly": true}, "phone_number": {"type": "string", "description": "The phone number of the buyer, in E.164 format. For example, "+14155551111".", "nullable": true}}}, "description": "The set of mappings to use in the loyalty account search.  \n\nThis cannot be combined with `customer_ids`.  \n\nMax: 30 mappings", "nullable": true}, "customer_ids": {"type": "array", "items": {"type": "string"}, "description": "The set of customer IDs to use in the loyalty account search.  \n\nThis cannot be combined with `mappings`.  \n\nMax: 30 customer IDs", "nullable": true}}}, "limit": {"type": "integer", "description": "The maximum number of results to include in the response. The default value is 30.", "minimum": 1, "maximum": 200}, "cursor": {"type": "string", "description": "A pagination cursor returned by a previous call to \nthis endpoint. Provide this to retrieve the next set of \nresults for the original query.\n\nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."}}, "example": {"limit": 10, "query": {"mappings": [{"phone_number": "+14155551234"}]}}}',  # noqa: E501
    "CREATELOYALTYPROMOTION": '{"type": "object", "description": "Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) request.", "x-release-status": "PUBLIC", "x-params-example": "?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd", "required": ["loyalty_promotion", "idempotency_key"], "properties": {"loyalty_promotion": {"type": "object", "description": "Represents a promotion for a [loyalty program](entity:LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.", "x-release-status": "PUBLIC", "required": ["name", "incentive", "available_time"], "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the promotion.", "minLength": 1, "maxLength": 255, "readOnly": true}, "name": {"type": "string", "description": "The name of the promotion.", "minLength": 1, "maxLength": 70}, "incentive": {"type": "object", "description": "Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"type": {"type": "string", "enum": ["POINTS_MULTIPLIER", "POINTS_ADDITION"], "x-enum-elements": [{"name": "POINTS_MULTIPLIER", "description": "Multiply the number of points earned from the base loyalty program.\nFor example, "Earn double points.""}, {"name": "POINTS_ADDITION", "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, "Earn 10 additional points.""}], "description": "Indicates the type of points incentive for a [loyalty promotion](entity:LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.", "x-release-status": "PUBLIC"}, "points_multiplier_data": {"type": "object", "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC", "properties": {"points_multiplier": {"type": "integer", "description": "The multiplier used to calculate the number of points earned each time the promotion\nis triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program.\nIf the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier`\nof 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points).\n\nDEPRECATED at version 2023-08-16. Replaced by the `multiplier` field.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) The `multiplier` field.\n- This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.", "minimum": 2, "maximum": 10, "x-release-status": "DEPRECATED", "nullable": true}, "multiplier": {"type": "string", "description": "The multiplier used to calculate the number of points earned each time the promotion is triggered,\nspecified as a string representation of a decimal. Square supports multipliers up to 10x, with three\npoint precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the\nbase loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a\n`multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points).\nFractional points are dropped.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) This `multiplier` field.\n- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.", "maxLength": 5, "nullable": true}}}, "points_addition_data": {"type": "object", "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).", "x-release-status": "PUBLIC", "required": ["points_addition"], "properties": {"points_addition": {"type": "integer", "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points = 8 points).", "minimum": 1}}}}}, "available_time": {"type": "object", "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](entity:LoyaltyPromotion).", "x-release-status": "PUBLIC", "required": ["time_periods"], "properties": {"start_date": {"type": "string", "description": "The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`.", "readOnly": true}, "end_date": {"type": "string", "description": "The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion\nremains available until it is canceled.", "readOnly": true}, "time_periods": {"type": "array", "items": {"type": "string"}, "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response."}}}, "trigger_limit": {"type": "object", "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](entity:LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.", "x-release-status": "PUBLIC", "required": ["times"], "properties": {"times": {"type": "integer", "description": "The maximum number of times a buyer can trigger the promotion during the specified `interval`.", "minimum": 1, "maximum": 30}, "interval": {"type": "string", "enum": ["ALL_TIME", "DAY"], "x-enum-elements": [{"name": "ALL_TIME", "description": "The limit applies to the entire time that the promotion is active. For example, if `times`\nis set to 1 and `time_period` is set to `ALL_TIME`, a buyer can earn promotion points a maximum\nof one time during the promotion."}, {"name": "DAY", "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day."}], "description": "Indicates the time period that the [trigger limit](entity:LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](entity:LoyaltyPromotion).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["ACTIVE", "ENDED", "CANCELED", "SCHEDULED"], "x-enum-elements": [{"name": "ACTIVE", "description": "The loyalty promotion is currently active. Buyers can earn points for purchases\nthat meet the promotion conditions, such as the promotion\'s `available_time`."}, {"name": "ENDED", "description": "The loyalty promotion has ended because the specified `end_date` was reached.\n`ENDED` is a terminal status."}, {"name": "CANCELED", "description": "The loyalty promotion was canceled. `CANCELED` is a terminal status."}, {"name": "SCHEDULED", "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached."}], "description": "Indicates the status of a [loyalty promotion](entity:LoyaltyPromotion).", "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The timestamp of when the promotion was created, in RFC 3339 format.", "readOnly": true}, "canceled_at": {"type": "string", "description": "The timestamp of when the promotion was canceled, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the promotion was last updated, in RFC 3339 format.", "readOnly": true}, "loyalty_program_id": {"type": "string", "description": "The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion.", "readOnly": true}, "minimum_spend_amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "qualifying_item_variation_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both.", "nullable": true}, "qualifying_category_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both.", "nullable": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, which is used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "minLength": 1, "maxLength": 128}}, "example": {"idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996", "loyalty_promotion": {"available_time": {"time_periods": ["BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"]}, "incentive": {"points_multiplier_data": {"multiplier": "3.0"}, "type": "POINTS_MULTIPLIER"}, "minimum_spend_amount_money": {"amount": 2000, "currency": "USD"}, "name": "Tuesday Happy Hour Promo", "qualifying_category_ids": ["XTQPYLR3IIU9C44VRCB3XD12"], "trigger_limit": {"interval": "DAY", "times": 1}}}}',  # noqa: E501
    "BULKDELETEMERCHANTCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) request.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes)\nrequest. An individual request contains an optional ID of the associated custom attribute definition\nand optional key of the associated custom attribute definition.", "x-release-status": "BETA", "properties": {"key": {"type": "string", "description": "The key of the associated custom attribute definition.\nRepresented as a qualified key if the requesting app is not the definition owner.", "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", "readOnly": true}}}, "description": "The data used to update the `CustomAttribute` objects.\nThe keys must be unique and are used to map to the corresponding response."}}, "example": {"values": {"id1": {"key": "alternative_seller_name", "merchant_id": "DM7VKY8Q63GNP"}, "id2": {"key": "has_seen_tutorial", "merchant_id": "DM7VKY8Q63GNP"}}}}',  # noqa: E501
    "UPSERTMERCHANTCUSTOMATTRIBUTESBULK": '{"type": "object", "description": "Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) request.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes)\nrequest. An individual request contains a merchant ID, the custom attribute to create or update,\nand an optional idempotency key.", "x-release-status": "BETA", "required": ["merchant_id", "custom_attribute"], "properties": {"merchant_id": {"type": "string", "description": "The ID of the target [merchant](entity:Merchant).", "minLength": 1}, "custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this individual upsert request, used to ensure idempotency.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}}, "description": "A map containing 1 to 25 individual upsert requests. For each request, provide an\narbitrary ID that is unique for this `BulkUpsertMerchantCustomAttributes` request and the\ninformation needed to create or update a custom attribute."}}, "example": {"values": {"id1": {"custom_attribute": {"key": "alternative_seller_name", "value": "Ultimate Sneaker Store"}, "merchant_id": "DM7VKY8Q63GNP"}, "id2": {"custom_attribute": {"key": "has_seen_tutorial", "value": true}, "merchant_id": "DM7VKY8Q63GNP"}}}}',  # noqa: E501
    "UPSERTMERCHANTCUSTOMATTRIBUTE": '{"type": "object", "description": "Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) request.", "x-release-status": "BETA", "x-params-example": "?merchant_id=DM7VKY8Q63GNP&key=alternative_seller_name", "required": ["custom_attribute"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 45, "nullable": true}}, "example": {"custom_attribute": {"value": "Ultimate Sneaker Store"}}}',  # noqa: E501
    "UPDATECHECKOUTLOCATIONSETTINGS": '{"type": "object", "x-release-status": "BETA", "required": ["location_settings"], "properties": {"location_settings": {"type": "object", "x-release-status": "BETA", "properties": {"location_id": {"type": "string", "description": "The ID of the location that these settings apply to.", "nullable": true}, "customer_notes_enabled": {"type": "boolean", "description": "Indicates whether customers are allowed to leave notes at checkout.", "nullable": true}, "policies": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it\u2019s optional when setting new policies.", "nullable": true}, "title": {"type": "string", "description": "The title of the policy. This is required when setting the description, though you can update it in a different request.", "maxLength": 50, "nullable": true}, "description": {"type": "string", "description": "The description of the policy.", "maxLength": 4096, "nullable": true}}}, "description": "Policy information is displayed at the bottom of the checkout pages.\nYou can set a maximum of two policies.", "nullable": true}, "branding": {"type": "object", "x-release-status": "BETA", "properties": {"header_type": {"type": "string", "enum": ["BUSINESS_NAME", "FRAMED_LOGO", "FULL_WIDTH_LOGO"], "x-enum-elements": [{"name": "BUSINESS_NAME", "description": ""}, {"name": "FRAMED_LOGO", "description": ""}, {"name": "FULL_WIDTH_LOGO", "description": ""}], "x-release-status": "BETA"}, "button_color": {"type": "string", "description": "The HTML-supported hex color for the button on the checkout page (for example, "#FFFFFF").", "minLength": 7, "maxLength": 7, "nullable": true}, "button_shape": {"type": "string", "enum": ["SQUARED", "ROUNDED", "PILL"], "x-enum-elements": [{"name": "SQUARED", "description": ""}, {"name": "ROUNDED", "description": ""}, {"name": "PILL", "description": ""}], "x-release-status": "BETA"}}}, "tipping": {"type": "object", "x-release-status": "BETA", "properties": {"percentages": {"type": "array", "items": {"type": "integer"}, "description": "Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.", "nullable": true}, "smart_tipping_enabled": {"type": "boolean", "description": "Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows:\nIf a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3.\nIf a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%. \nYou can set custom percentage amounts with the `percentages` field.", "nullable": true}, "default_percent": {"type": "integer", "description": "Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more.", "nullable": true}, "smart_tips": {"type": "array", "items": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "description": "Show the Smart Tip Amounts for this location.", "nullable": true}, "default_smart_tip": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "coupons": {"type": "object", "x-release-status": "BETA", "properties": {"enabled": {"type": "boolean", "description": "Indicates whether coupons are enabled for this location.", "nullable": true}}}, "updated_at": {"type": "string", "description": "The timestamp when the settings were last updated, in RFC 3339 format.\nExamples for January 25th, 2020 6:25:34pm Pacific Standard Time:\nUTC: 2020-01-26T02:25:34Z\nPacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00", "readOnly": true}}}}}',  # noqa: E501
    "UPDATEMERCHANTSETTINGS": '{"type": "object", "x-release-status": "BETA", "required": ["merchant_settings"], "properties": {"merchant_settings": {"type": "object", "x-release-status": "BETA", "properties": {"payment_methods": {"type": "object", "x-release-status": "BETA", "properties": {"apple_pay": {"type": "object", "description": "The settings allowed for a payment method.", "x-release-status": "BETA", "properties": {"enabled": {"type": "boolean", "description": "Indicates whether the payment method is enabled for the account.", "nullable": true}}}, "google_pay": {"type": "object", "description": "The settings allowed for a payment method.", "x-release-status": "BETA", "properties": {"enabled": {"type": "boolean", "description": "Indicates whether the payment method is enabled for the account.", "nullable": true}}}, "cash_app": {"type": "object", "description": "The settings allowed for a payment method.", "x-release-status": "BETA", "properties": {"enabled": {"type": "boolean", "description": "Indicates whether the payment method is enabled for the account.", "nullable": true}}}, "afterpay_clearpay": {"type": "object", "description": "The settings allowed for AfterpayClearpay.", "x-release-status": "BETA", "properties": {"order_eligibility_range": {"type": "object", "description": "A range of purchase price that qualifies.", "x-release-status": "BETA", "required": ["min", "max"], "properties": {"min": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "max": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "item_eligibility_range": {"type": "object", "description": "A range of purchase price that qualifies.", "x-release-status": "BETA", "required": ["min", "max"], "properties": {"min": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "max": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "enabled": {"type": "boolean", "description": "Indicates whether the payment method is enabled for the account.", "readOnly": true}}}}}, "updated_at": {"type": "string", "description": "The timestamp when the settings were last updated, in RFC 3339 format.\nExamples for January 25th, 2020 6:25:34pm Pacific Standard Time:\nUTC: 2020-01-26T02:25:34Z\nPacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00", "readOnly": true}}}}}',  # noqa: E501
    "CREATEPAYMENTLINK": '{"type": "object", "x-release-status": "PUBLIC", "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreatePaymentLinkRequest` request.\nIf you do not provide a unique string (or provide an empty string as the value),\nthe endpoint treats each request as independent.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", "maxLength": 192}, "description": {"type": "string", "description": "A description of the payment link. You provide this optional description that is useful in your\napplication context. It is not used anywhere.", "maxLength": 4096}, "quick_pay": {"type": "object", "description": "Describes an ad hoc item and price to generate a quick pay checkout link.\nFor more information,\nsee [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout).", "x-release-status": "PUBLIC", "required": ["name", "price_money", "location_id"], "properties": {"name": {"type": "string", "description": "The ad hoc item name. In the resulting `Order`, this name appears as the line item name.", "minLength": 1, "maxLength": 255}, "price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "location_id": {"type": "string", "description": "The ID of the business location the checkout is associated with."}}}, "order": {"type": "object", "description": "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data.", "x-release-status": "PUBLIC", "required": ["location_id"], "properties": {"id": {"type": "string", "description": "The order\'s unique ID.", "readOnly": true}, "location_id": {"type": "string", "description": "The ID of the seller location that this order is associated with.", "minLength": 1}, "reference_id": {"type": "string", "description": "A client-specified ID to associate an entity in another system\nwith this order.", "maxLength": 40, "nullable": true}, "source": {"type": "object", "description": "Represents the origination details of an order.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order.", "nullable": true}}}, "customer_id": {"type": "string", "description": "The ID of the [customer](entity:Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "maxLength": 191, "x-release-status": "BETA", "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details.", "x-release-status": "PUBLIC", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the line item only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The count, or measurement, of a line item being purchased:\n\nIf `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count.  For example: `3` apples.\n\nIf `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement.  For example: `2.25` pounds of broccoli.\n\nFor more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).\n\nLine items with a quantity of `0` are automatically removed\nwhen paying for or otherwise completing the order.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "An optional note associated with the line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "modifiers": {"type": "array", "items": {"type": "object", "description": "A [CatalogModifier](entity:CatalogModifier).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the modifier only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount.", "x-release-status": "BETA", "nullable": true}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to service charges applied to this line item. Each\n`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a\ntop-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is\npopulated.\n\nTo change the amount of a service charge, modify the referenced top-level service charge.", "x-release-status": "BETA", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_sales_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_blocklists": {"type": "object", "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", "x-release-status": "BETA", "properties": {"blocked_discounts": {"type": "array", "items": {"type": "object", "description": "A discount to block from applying to a line item. The discount must be\nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedDiscount` within the order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that should be blocked. Use this field to block\nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "discount_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the discount that should be blocked.\nUse this field to block catalog discounts. For ad hoc discounts, use the\n`discount_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of discounts blocked from applying to the line item.\nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or\nthe `discount_catalog_object_id` (for catalog discounts).", "nullable": true}, "blocked_taxes": {"type": "array", "items": {"type": "object", "description": "A tax to block from applying to a line item. The tax must be\nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedTax` within the order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax that should be blocked. Use this field to block\nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "tax_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the tax that should be blocked.\nUse this field to block catalog taxes. For ad hoc taxes, use the\n`tax_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of taxes blocked from applying to the line item.\nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or\nthe `tax_catalog_object_id` (for catalog taxes).", "nullable": true}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The line items included in the order.", "nullable": true}, "taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tax only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `"7.25"` corresponds to a percentage of\n7.25%.", "maxLength": 10, "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}, "auto_applied": {"type": "boolean", "description": "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see\n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).", "readOnly": true, "x-release-status": "BETA"}}}, "description": "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead.", "nullable": true}, "discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the discount only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}, "reward_ids": {"type": "array", "items": {"type": "string"}, "description": "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API.", "readOnly": true, "x-release-status": "BETA"}, "pricing_rule_id": {"type": "string", "description": "The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "readOnly": true}}}, "description": "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead.", "nullable": true}, "service_charges": {"type": "array", "items": {"type": "object", "description": "Represents a service charge applied to an order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 512, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The service charge percentage as a string representation of a\ndecimal number. For example, `"7.25"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["AUTO_GRATUITY", "CUSTOM"], "x-enum-elements": [{"name": "AUTO_GRATUITY", "description": ""}, {"name": "CUSTOM", "description": ""}], "x-release-status": "PUBLIC"}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A list of service charges applied to the order.", "nullable": true}, "fulfillments": {"type": "array", "items": {"type": "object", "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["PICKUP", "SHIPMENT", "DELIVERY"], "x-enum-elements": [{"name": "PICKUP", "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)."}, {"name": "SHIPMENT", "description": "A shipping carrier to ship the fulfillment."}, {"name": "DELIVERY", "description": "A courier to deliver the fulfillment."}], "description": "The type of fulfillment.", "x-release-status": "PUBLIC"}, "state": {"type": "string", "enum": ["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], "x-enum-elements": [{"name": "PROPOSED", "description": "Indicates that the fulfillment has been proposed."}, {"name": "RESERVED", "description": "Indicates that the fulfillment has been reserved."}, {"name": "PREPARED", "description": "Indicates that the fulfillment has been prepared."}, {"name": "COMPLETED", "description": "Indicates that the fulfillment was successfully completed."}, {"name": "CANCELED", "description": "Indicates that the fulfillment was canceled."}, {"name": "FAILED", "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled."}], "description": "The current state of this fulfillment.", "x-release-status": "PUBLIC"}, "line_item_application": {"type": "string", "enum": ["ALL", "ENTRY_LIST"], "x-enum-elements": [{"name": "ALL", "description": "If `ALL`, `entries` must be unset."}, {"name": "ENTRY_LIST", "description": "If `ENTRY_LIST`, supply a list of `entries`."}], "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", "x-release-status": "BETA"}, "entries": {"type": "array", "items": {"type": "object", "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", "x-release-status": "BETA", "required": ["line_item_uid", "quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment entry only within this order.", "maxLength": 60, "nullable": true}, "line_item_uid": {"type": "string", "description": "The `uid` from the order line item.", "minLength": 1}, "quantity": {"type": "string", "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `"3"`.\n\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "nullable": true}}}, "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\n\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder\'s line item itself.\n\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "pickup_details": {"type": "object", "description": "Contains details necessary to fulfill a pickup order.", "x-release-status": "PUBLIC", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "expires_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", "nullable": true}, "auto_complete_duration": {"type": "string", "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", "nullable": true}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time."}, {"name": "ASAP", "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately."}], "description": "The schedule type of the pickup fulfillment.", "x-release-status": "PUBLIC"}, "pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n"2016-09-04T23:59:33.123Z".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", "nullable": true}, "pickup_window_duration": {"type": "string", "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an\ninformational guideline for merchants.", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", "maxLength": 500, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "accepted_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expired_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "picked_up_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", "maxLength": 100, "nullable": true}, "is_curbside_pickup": {"type": "boolean", "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", "x-release-status": "BETA", "nullable": true}, "curbside_pickup_details": {"type": "object", "description": "Specific details for curbside pickup.", "x-release-status": "BETA", "properties": {"curbside_details": {"type": "string", "description": "Specific details for curbside pickup, such as parking number and vehicle model.", "maxLength": 250, "nullable": true}, "buyer_arrived_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}}}}}, "shipment_details": {"type": "object", "description": "Contains the details necessary to fulfill a shipment order.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "carrier": {"type": "string", "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", "maxLength": 50, "nullable": true}, "shipping_note": {"type": "string", "description": "A note with additional information for the shipping carrier.", "maxLength": 500, "nullable": true}, "shipping_type": {"type": "string", "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", "maxLength": 50, "nullable": true}, "tracking_number": {"type": "string", "description": "The reference number provided by the carrier to track the shipment\'s progress.", "maxLength": 100, "nullable": true}, "tracking_url": {"type": "string", "description": "A link to the tracking webpage on the carrier\'s website.", "maxLength": 2000, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "packaged_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expected_shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "cancel_reason": {"type": "string", "description": "A description of why the shipment was canceled.", "maxLength": 100, "nullable": true}, "failed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "failure_reason": {"type": "string", "description": "A description of why the shipment failed to be completed.", "maxLength": 100, "nullable": true}}}, "delivery_details": {"type": "object", "description": "Describes delivery details of an order fulfillment.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates the fulfillment to deliver at a scheduled deliver time."}, {"name": "ASAP", "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately."}], "description": "The schedule type of the delivery fulfillment.", "x-release-status": "BETA"}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").\n\nMust be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".", "readOnly": true}, "deliver_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "delivery_window_duration": {"type": "string", "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", "maxLength": 550, "nullable": true}, "completed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when  fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "delivered_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "The delivery cancellation reason. Max length: 100 characters.", "maxLength": 100, "nullable": true}, "courier_pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "courier_pickup_window_duration": {"type": "string", "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "is_no_contact_delivery": {"type": "boolean", "description": "Whether the delivery is preferred to be no contact.", "nullable": true}, "dropoff_notes": {"type": "string", "description": "A note to provide additional instructions about how to deliver the order.", "maxLength": 550, "nullable": true}, "courier_provider_name": {"type": "string", "description": "The name of the courier provider.", "maxLength": 255, "nullable": true}, "courier_support_phone_number": {"type": "string", "description": "The support phone number of the courier.", "maxLength": 17, "nullable": true}, "square_delivery_id": {"type": "string", "description": "The identifier for the delivery created by Square.", "maxLength": 50, "nullable": true}, "external_delivery_id": {"type": "string", "description": "The identifier for the delivery created by the third-party courier service.", "maxLength": 50, "nullable": true}, "managed_delivery": {"type": "boolean", "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", "nullable": true}}}}}, "description": "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments.", "nullable": true}, "returns": {"type": "array", "items": {"type": "object", "description": "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return only within this order.", "maxLength": 60, "nullable": true}, "source_order_id": {"type": "string", "description": "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns.", "nullable": true}, "return_line_items": {"type": "array", "items": {"type": "object", "description": "The line item being returned in an order.", "x-release-status": "BETA", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID for this return line-item entry.", "maxLength": 60, "nullable": true}, "source_line_item_uid": {"type": "string", "description": "The `uid` of the line item in the original sale order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The quantity returned, formatted as a decimal number.\nFor example, `"3"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "The note of the return line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this return line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "return_modifiers": {"type": "array", "items": {"type": "object", "description": "A line item modifier being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return modifier only within this order.", "maxLength": 60, "nullable": true}, "source_modifier_uid": {"type": "string", "description": "The modifier `uid` from the order\'s line item that contains the\noriginal sale of this line item modifier.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_return_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnServiceCharge` entities applied to the return\nline item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that\nreferences the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line\nitem. On reads, the applied amount is populated.", "nullable": true}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "A collection of line items that are being returned.", "nullable": true}, "return_service_charges": {"type": "array", "items": {"type": "object", "description": "Represents the service charge applied to the original order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "source_service_charge_uid": {"type": "string", "description": "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 255, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `"7.25"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated.", "x-release-status": "BETA", "nullable": true}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A collection of service charges that are being returned.", "nullable": true}, "return_taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned tax only within this order.", "maxLength": 60, "nullable": true}, "source_tax_uid": {"type": "string", "description": "The tax `uid` from the order that contains the original tax charge.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `"7.25"` corresponds to a percentage of 7.25%.", "maxLength": 10, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder.", "readOnly": true}, "return_discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned discount only within this order.", "maxLength": 60, "nullable": true}, "source_discount_uid": {"type": "string", "description": "The discount `uid` from the order that contains the original application of this discount.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nA value of `"7.25"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order.", "readOnly": true}, "return_tips": {"type": "array", "items": {"type": "object", "description": "A tip being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tip only within this order.", "maxLength": 60, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "source_tender_uid": {"type": "string", "description": "The tender `uid` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}, "source_tender_id": {"type": "string", "description": "The tender `id` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}}}, "description": "A collection of references to tips being returned for an order.", "nullable": true}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced.", "readOnly": true, "x-release-status": "BETA"}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "net_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "tenders": {"type": "array", "items": {"type": "object", "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"id": {"type": "string", "description": "The tender\'s unique ID. It is the associated payment ID.", "maxLength": 192}, "location_id": {"type": "string", "description": "The ID of the transaction\'s associated location.", "maxLength": 50, "nullable": true}, "transaction_id": {"type": "string", "description": "The ID of the tender\'s associated transaction.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the tender was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "note": {"type": "string", "description": "An optional note associated with the tender at the time of payment.", "maxLength": 500, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_id": {"type": "string", "description": "If the tender is associated with a customer or represents a customer\'s card on file,\nthis is the ID of the associated customer.", "maxLength": 191, "nullable": true}, "type": {"type": "string", "enum": ["CARD", "CASH", "THIRD_PARTY_CARD", "SQUARE_GIFT_CARD", "NO_SALE", "BANK_ACCOUNT", "WALLET", "BUY_NOW_PAY_LATER", "SQUARE_ACCOUNT", "OTHER"], "x-enum-elements": [{"name": "CARD", "description": "A credit card."}, {"name": "CASH", "description": "Cash."}, {"name": "THIRD_PARTY_CARD", "description": "A credit card processed with a card processor other than Square.\n\nThis value applies only to merchants in countries where Square does not\nyet provide card processing."}, {"name": "SQUARE_GIFT_CARD", "description": "A Square gift card."}, {"name": "NO_SALE", "description": "This tender represents the register being opened for a "no sale" event."}, {"name": "BANK_ACCOUNT", "description": "A bank account payment."}, {"name": "WALLET", "description": "A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,\nAu Pay, D Barai, Merpay, Wechat Pay, Alipay.\n\nNote: Some "digital wallets", including Google Pay and Apple Pay, facilitate\ncard payments.  Those payments have the `CARD` type."}, {"name": "BUY_NOW_PAY_LATER", "description": "A Buy Now Pay Later payment."}, {"name": "SQUARE_ACCOUNT", "description": "A Square House Account payment."}, {"name": "OTHER", "description": "A form of tender that does not match any other value."}], "description": "Indicates a tender\'s type.", "x-release-status": "PUBLIC"}, "card_details": {"type": "object", "description": "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The card transaction has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The card transaction was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The card transaction was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The card transaction failed."}], "description": "Indicates the card transaction\'s current status.", "x-release-status": "PUBLIC"}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}, "entry_method": {"type": "string", "enum": ["SWIPED", "KEYED", "EMV", "ON_FILE", "CONTACTLESS"], "x-enum-elements": [{"name": "SWIPED", "description": "The card was swiped through a Square reader or Square stand."}, {"name": "KEYED", "description": "The card information was keyed manually into Square Point of Sale or a\nSquare-hosted web form."}, {"name": "EMV", "description": "The card was processed via EMV with a Square reader."}, {"name": "ON_FILE", "description": "The buyer\'s card details were already on file with Square."}, {"name": "CONTACTLESS", "description": "The card was processed via a contactless (i.e., NFC) transaction\nwith a Square reader."}], "description": "Indicates the method used to enter the card\'s details.", "x-release-status": "PUBLIC"}}}, "cash_details": {"type": "object", "description": "Represents the details of a tender with `type` `CASH`.", "x-release-status": "PUBLIC", "properties": {"buyer_tendered_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "bank_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](entity:BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["PENDING", "COMPLETED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The bank account payment is in progress."}, {"name": "COMPLETED", "description": "The bank account payment has been completed."}, {"name": "FAILED", "description": "The bank account payment failed."}], "description": "Indicates the bank account payment\'s current status.", "x-release-status": "PUBLIC"}}}, "buy_now_pay_later_details": {"type": "object", "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", "x-release-status": "PUBLIC", "properties": {"buy_now_pay_later_brand": {"type": "string", "enum": ["OTHER_BRAND", "AFTERPAY"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "AFTERPAY", "description": ""}], "x-release-status": "PUBLIC"}, "status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The buy now pay later payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The buy now pay later payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The buy now pay later payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The buy now pay later payment failed."}], "x-release-status": "PUBLIC"}}}, "square_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The Square Account payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The Square Account payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The Square Account payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The Square Account payment failed."}], "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the [Payment](entity:Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API.", "maxLength": 192, "nullable": true}}}, "description": "The tenders that were used to pay for the order.", "readOnly": true, "x-release-status": "BETA"}, "refunds": {"type": "array", "items": {"type": "object", "description": "Represents a refund processed for a Square transaction.", "x-release-status": "PUBLIC", "required": ["id", "location_id", "reason", "amount_money", "status"], "properties": {"id": {"type": "string", "description": "The refund\'s unique ID.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the refund\'s associated location.", "maxLength": 50}, "transaction_id": {"type": "string", "description": "The ID of the transaction that the refunded tender is part of.", "maxLength": 192, "nullable": true}, "tender_id": {"type": "string", "description": "The ID of the refunded tender.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the refund was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "reason": {"type": "string", "description": "The reason for the refund being issued.", "maxLength": 192}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["PENDING", "APPROVED", "REJECTED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The refund is pending."}, {"name": "APPROVED", "description": "The refund has been approved by Square."}, {"name": "REJECTED", "description": "The refund has been rejected by Square."}, {"name": "FAILED", "description": "The refund failed."}], "description": "Indicates a refund\'s current status.", "x-release-status": "PUBLIC"}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}}}, "description": "The refunds that are part of this order.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "closed_at": {"type": "string", "description": "The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z").", "readOnly": true}, "state": {"type": "string", "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"], "x-enum-elements": [{"name": "OPEN", "description": "Indicates that the order is open. Open orders can be updated."}, {"name": "COMPLETED", "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state."}, {"name": "CANCELED", "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state."}, {"name": "DRAFT", "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)."}], "description": "The state of the order.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).", "x-release-status": "BETA"}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ticket_name": {"type": "string", "description": "A short-term identifier for the order (such as a customer first name,\ntable number, or auto-generated order number that resets daily).", "maxLength": 30, "x-release-status": "BETA", "nullable": true}, "pricing_options": {"type": "object", "description": "Pricing options for an order. The options affect how the order\'s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](entity:CatalogPricingRule).", "x-release-status": "PUBLIC", "properties": {"auto_apply_discounts": {"type": "boolean", "description": "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order.", "nullable": true}, "auto_apply_taxes": {"type": "boolean", "description": "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met.", "x-release-status": "BETA", "nullable": true}}}, "rewards": {"type": "array", "items": {"type": "object", "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", "x-release-status": "BETA", "required": ["id", "reward_tier_id"], "properties": {"id": {"type": "string", "description": "The identifier of the reward.", "minLength": 1}, "reward_tier_id": {"type": "string", "description": "The identifier of the reward tier corresponding to this reward.", "minLength": 1}}}, "description": "A set-like list of Rewards that have been added to the Order.", "readOnly": true, "x-release-status": "BETA"}, "net_amount_due_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "checkout_options": {"type": "object", "x-release-status": "PUBLIC", "properties": {"allow_tipping": {"type": "boolean", "description": "Indicates whether the payment allows tipping.", "nullable": true}, "custom_fields": {"type": "array", "items": {"type": "object", "description": "Describes a custom form field to add to the checkout page to collect more information from buyers during checkout.\nFor more information,\nsee [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1).", "x-release-status": "PUBLIC", "required": ["title"], "properties": {"title": {"type": "string", "description": "The title of the custom field.", "minLength": 1, "maxLength": 50}}}, "description": "The custom fields requesting information from the buyer.", "nullable": true}, "subscription_plan_id": {"type": "string", "description": "The ID of the subscription plan for the buyer to pay and subscribe.\nFor more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).", "maxLength": 255, "nullable": true}, "redirect_url": {"type": "string", "description": "The confirmation page URL to redirect the buyer to after Square processes the payment.", "maxLength": 2048, "nullable": true}, "merchant_support_email": {"type": "string", "description": "The email address that buyers can use to contact the seller.", "maxLength": 256, "nullable": true}, "ask_for_shipping_address": {"type": "boolean", "description": "Indicates whether to include the address fields in the payment form.", "nullable": true}, "accepted_payment_methods": {"type": "object", "x-release-status": "PUBLIC", "properties": {"apple_pay": {"type": "boolean", "description": "Whether Apple Pay is accepted at checkout.", "nullable": true}, "google_pay": {"type": "boolean", "description": "Whether Google Pay is accepted at checkout.", "nullable": true}, "cash_app_pay": {"type": "boolean", "description": "Whether Cash App Pay is accepted at checkout.", "nullable": true}, "afterpay_clearpay": {"type": "boolean", "description": "Whether Afterpay/Clearpay is accepted at checkout.", "nullable": true}}}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "shipping_fee": {"type": "object", "x-release-status": "PUBLIC", "required": ["charge"], "properties": {"name": {"type": "string", "description": "The name for the shipping fee.", "nullable": true}, "charge": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "enable_coupon": {"type": "boolean", "description": "Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.", "nullable": true}, "enable_loyalty": {"type": "boolean", "description": "Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.", "nullable": true}}}, "pre_populated_data": {"type": "object", "description": "Describes buyer data to prepopulate in the payment form.\nFor more information,\nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).", "x-release-status": "PUBLIC", "properties": {"buyer_email": {"type": "string", "description": "The buyer email to prepopulate in the payment form.", "maxLength": 256, "nullable": true}, "buyer_phone_number": {"type": "string", "description": "The buyer phone number to prepopulate in the payment form.", "maxLength": 17, "nullable": true}, "buyer_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "payment_note": {"type": "string", "description": "A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.", "maxLength": 500}}, "example": {"idempotency_key": "cd9e25dc-d9f2-4430-aedb-61605070e95f", "quick_pay": {"location_id": "A9Y43N9ABXZBP", "name": "Auto Detailing", "price_money": {"amount": 10000, "currency": "USD"}}}}',  # noqa: E501
    "UPDATEPAYMENTLINK": '{"type": "object", "x-release-status": "PUBLIC", "required": ["payment_link"], "properties": {"payment_link": {"type": "object", "x-release-status": "PUBLIC", "required": ["version"], "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the payment link.", "readOnly": true}, "version": {"type": "integer", "description": "The Square-assigned version number, which is incremented each time an update is committed to the payment link.", "maximum": 65535}, "description": {"type": "string", "description": "The optional description of the `payment_link` object.\nIt is primarily for use by your application and is not used anywhere.", "maxLength": 4096, "nullable": true}, "order_id": {"type": "string", "description": "The ID of the order associated with the payment link.", "maxLength": 192, "readOnly": true}, "checkout_options": {"type": "object", "x-release-status": "PUBLIC", "properties": {"allow_tipping": {"type": "boolean", "description": "Indicates whether the payment allows tipping.", "nullable": true}, "custom_fields": {"type": "array", "items": {"type": "object", "description": "Describes a custom form field to add to the checkout page to collect more information from buyers during checkout.\nFor more information,\nsee [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1).", "x-release-status": "PUBLIC", "required": ["title"], "properties": {"title": {"type": "string", "description": "The title of the custom field.", "minLength": 1, "maxLength": 50}}}, "description": "The custom fields requesting information from the buyer.", "nullable": true}, "subscription_plan_id": {"type": "string", "description": "The ID of the subscription plan for the buyer to pay and subscribe.\nFor more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).", "maxLength": 255, "nullable": true}, "redirect_url": {"type": "string", "description": "The confirmation page URL to redirect the buyer to after Square processes the payment.", "maxLength": 2048, "nullable": true}, "merchant_support_email": {"type": "string", "description": "The email address that buyers can use to contact the seller.", "maxLength": 256, "nullable": true}, "ask_for_shipping_address": {"type": "boolean", "description": "Indicates whether to include the address fields in the payment form.", "nullable": true}, "accepted_payment_methods": {"type": "object", "x-release-status": "PUBLIC", "properties": {"apple_pay": {"type": "boolean", "description": "Whether Apple Pay is accepted at checkout.", "nullable": true}, "google_pay": {"type": "boolean", "description": "Whether Google Pay is accepted at checkout.", "nullable": true}, "cash_app_pay": {"type": "boolean", "description": "Whether Cash App Pay is accepted at checkout.", "nullable": true}, "afterpay_clearpay": {"type": "boolean", "description": "Whether Afterpay/Clearpay is accepted at checkout.", "nullable": true}}}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "shipping_fee": {"type": "object", "x-release-status": "PUBLIC", "required": ["charge"], "properties": {"name": {"type": "string", "description": "The name for the shipping fee.", "nullable": true}, "charge": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "enable_coupon": {"type": "boolean", "description": "Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form.", "nullable": true}, "enable_loyalty": {"type": "boolean", "description": "Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.", "nullable": true}}}, "pre_populated_data": {"type": "object", "description": "Describes buyer data to prepopulate in the payment form.\nFor more information,\nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).", "x-release-status": "PUBLIC", "properties": {"buyer_email": {"type": "string", "description": "The buyer email to prepopulate in the payment form.", "maxLength": 256, "nullable": true}, "buyer_phone_number": {"type": "string", "description": "The buyer phone number to prepopulate in the payment form.", "maxLength": 17, "nullable": true}, "buyer_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "url": {"type": "string", "description": "The shortened URL of the payment link.", "maxLength": 255, "readOnly": true}, "long_url": {"type": "string", "description": "The long URL of the payment link.", "maxLength": 255, "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp when the payment link was created, in RFC 3339 format."}, "updated_at": {"type": "string", "description": "The timestamp when the payment link was last updated, in RFC 3339 format."}, "payment_note": {"type": "string", "description": "An optional note. After Square processes the payment, this note is added to the\nresulting `Payment`.", "maxLength": 500, "nullable": true}}}}, "example": {"payment_link": {"checkout_options": {"ask_for_shipping_address": true}, "version": 1}}}',  # noqa: E501
    "CREATEORDERFORPURCHASE": '{"type": "object", "x-release-status": "PUBLIC", "properties": {"order": {"type": "object", "description": "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data.", "x-release-status": "PUBLIC", "required": ["location_id"], "properties": {"id": {"type": "string", "description": "The order\'s unique ID.", "readOnly": true}, "location_id": {"type": "string", "description": "The ID of the seller location that this order is associated with.", "minLength": 1}, "reference_id": {"type": "string", "description": "A client-specified ID to associate an entity in another system\nwith this order.", "maxLength": 40, "nullable": true}, "source": {"type": "object", "description": "Represents the origination details of an order.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order.", "nullable": true}}}, "customer_id": {"type": "string", "description": "The ID of the [customer](entity:Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "maxLength": 191, "x-release-status": "BETA", "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details.", "x-release-status": "PUBLIC", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the line item only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The count, or measurement, of a line item being purchased:\n\nIf `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count.  For example: `3` apples.\n\nIf `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement.  For example: `2.25` pounds of broccoli.\n\nFor more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).\n\nLine items with a quantity of `0` are automatically removed\nwhen paying for or otherwise completing the order.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "An optional note associated with the line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "modifiers": {"type": "array", "items": {"type": "object", "description": "A [CatalogModifier](entity:CatalogModifier).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the modifier only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount.", "x-release-status": "BETA", "nullable": true}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to service charges applied to this line item. Each\n`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a\ntop-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is\npopulated.\n\nTo change the amount of a service charge, modify the referenced top-level service charge.", "x-release-status": "BETA", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_sales_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_blocklists": {"type": "object", "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", "x-release-status": "BETA", "properties": {"blocked_discounts": {"type": "array", "items": {"type": "object", "description": "A discount to block from applying to a line item. The discount must be\nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedDiscount` within the order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that should be blocked. Use this field to block\nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "discount_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the discount that should be blocked.\nUse this field to block catalog discounts. For ad hoc discounts, use the\n`discount_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of discounts blocked from applying to the line item.\nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or\nthe `discount_catalog_object_id` (for catalog discounts).", "nullable": true}, "blocked_taxes": {"type": "array", "items": {"type": "object", "description": "A tax to block from applying to a line item. The tax must be\nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedTax` within the order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax that should be blocked. Use this field to block\nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "tax_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the tax that should be blocked.\nUse this field to block catalog taxes. For ad hoc taxes, use the\n`tax_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of taxes blocked from applying to the line item.\nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or\nthe `tax_catalog_object_id` (for catalog taxes).", "nullable": true}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The line items included in the order.", "nullable": true}, "taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tax only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `"7.25"` corresponds to a percentage of\n7.25%.", "maxLength": 10, "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}, "auto_applied": {"type": "boolean", "description": "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see\n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).", "readOnly": true, "x-release-status": "BETA"}}}, "description": "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead.", "nullable": true}, "discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the discount only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}, "reward_ids": {"type": "array", "items": {"type": "string"}, "description": "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API.", "readOnly": true, "x-release-status": "BETA"}, "pricing_rule_id": {"type": "string", "description": "The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "readOnly": true}}}, "description": "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead.", "nullable": true}, "service_charges": {"type": "array", "items": {"type": "object", "description": "Represents a service charge applied to an order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 512, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The service charge percentage as a string representation of a\ndecimal number. For example, `"7.25"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["AUTO_GRATUITY", "CUSTOM"], "x-enum-elements": [{"name": "AUTO_GRATUITY", "description": ""}, {"name": "CUSTOM", "description": ""}], "x-release-status": "PUBLIC"}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A list of service charges applied to the order.", "nullable": true}, "fulfillments": {"type": "array", "items": {"type": "object", "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["PICKUP", "SHIPMENT", "DELIVERY"], "x-enum-elements": [{"name": "PICKUP", "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)."}, {"name": "SHIPMENT", "description": "A shipping carrier to ship the fulfillment."}, {"name": "DELIVERY", "description": "A courier to deliver the fulfillment."}], "description": "The type of fulfillment.", "x-release-status": "PUBLIC"}, "state": {"type": "string", "enum": ["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], "x-enum-elements": [{"name": "PROPOSED", "description": "Indicates that the fulfillment has been proposed."}, {"name": "RESERVED", "description": "Indicates that the fulfillment has been reserved."}, {"name": "PREPARED", "description": "Indicates that the fulfillment has been prepared."}, {"name": "COMPLETED", "description": "Indicates that the fulfillment was successfully completed."}, {"name": "CANCELED", "description": "Indicates that the fulfillment was canceled."}, {"name": "FAILED", "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled."}], "description": "The current state of this fulfillment.", "x-release-status": "PUBLIC"}, "line_item_application": {"type": "string", "enum": ["ALL", "ENTRY_LIST"], "x-enum-elements": [{"name": "ALL", "description": "If `ALL`, `entries` must be unset."}, {"name": "ENTRY_LIST", "description": "If `ENTRY_LIST`, supply a list of `entries`."}], "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", "x-release-status": "BETA"}, "entries": {"type": "array", "items": {"type": "object", "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", "x-release-status": "BETA", "required": ["line_item_uid", "quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment entry only within this order.", "maxLength": 60, "nullable": true}, "line_item_uid": {"type": "string", "description": "The `uid` from the order line item.", "minLength": 1}, "quantity": {"type": "string", "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `"3"`.\n\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "nullable": true}}}, "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\n\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder\'s line item itself.\n\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "pickup_details": {"type": "object", "description": "Contains details necessary to fulfill a pickup order.", "x-release-status": "PUBLIC", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "expires_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", "nullable": true}, "auto_complete_duration": {"type": "string", "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", "nullable": true}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time."}, {"name": "ASAP", "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately."}], "description": "The schedule type of the pickup fulfillment.", "x-release-status": "PUBLIC"}, "pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n"2016-09-04T23:59:33.123Z".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", "nullable": true}, "pickup_window_duration": {"type": "string", "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an\ninformational guideline for merchants.", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", "maxLength": 500, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "accepted_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expired_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "picked_up_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", "maxLength": 100, "nullable": true}, "is_curbside_pickup": {"type": "boolean", "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", "x-release-status": "BETA", "nullable": true}, "curbside_pickup_details": {"type": "object", "description": "Specific details for curbside pickup.", "x-release-status": "BETA", "properties": {"curbside_details": {"type": "string", "description": "Specific details for curbside pickup, such as parking number and vehicle model.", "maxLength": 250, "nullable": true}, "buyer_arrived_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}}}}}, "shipment_details": {"type": "object", "description": "Contains the details necessary to fulfill a shipment order.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "carrier": {"type": "string", "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", "maxLength": 50, "nullable": true}, "shipping_note": {"type": "string", "description": "A note with additional information for the shipping carrier.", "maxLength": 500, "nullable": true}, "shipping_type": {"type": "string", "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", "maxLength": 50, "nullable": true}, "tracking_number": {"type": "string", "description": "The reference number provided by the carrier to track the shipment\'s progress.", "maxLength": 100, "nullable": true}, "tracking_url": {"type": "string", "description": "A link to the tracking webpage on the carrier\'s website.", "maxLength": 2000, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "packaged_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expected_shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "cancel_reason": {"type": "string", "description": "A description of why the shipment was canceled.", "maxLength": 100, "nullable": true}, "failed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "failure_reason": {"type": "string", "description": "A description of why the shipment failed to be completed.", "maxLength": 100, "nullable": true}}}, "delivery_details": {"type": "object", "description": "Describes delivery details of an order fulfillment.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates the fulfillment to deliver at a scheduled deliver time."}, {"name": "ASAP", "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately."}], "description": "The schedule type of the delivery fulfillment.", "x-release-status": "BETA"}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").\n\nMust be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".", "readOnly": true}, "deliver_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "delivery_window_duration": {"type": "string", "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", "maxLength": 550, "nullable": true}, "completed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when  fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "delivered_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "The delivery cancellation reason. Max length: 100 characters.", "maxLength": 100, "nullable": true}, "courier_pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "courier_pickup_window_duration": {"type": "string", "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "is_no_contact_delivery": {"type": "boolean", "description": "Whether the delivery is preferred to be no contact.", "nullable": true}, "dropoff_notes": {"type": "string", "description": "A note to provide additional instructions about how to deliver the order.", "maxLength": 550, "nullable": true}, "courier_provider_name": {"type": "string", "description": "The name of the courier provider.", "maxLength": 255, "nullable": true}, "courier_support_phone_number": {"type": "string", "description": "The support phone number of the courier.", "maxLength": 17, "nullable": true}, "square_delivery_id": {"type": "string", "description": "The identifier for the delivery created by Square.", "maxLength": 50, "nullable": true}, "external_delivery_id": {"type": "string", "description": "The identifier for the delivery created by the third-party courier service.", "maxLength": 50, "nullable": true}, "managed_delivery": {"type": "boolean", "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", "nullable": true}}}}}, "description": "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments.", "nullable": true}, "returns": {"type": "array", "items": {"type": "object", "description": "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return only within this order.", "maxLength": 60, "nullable": true}, "source_order_id": {"type": "string", "description": "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns.", "nullable": true}, "return_line_items": {"type": "array", "items": {"type": "object", "description": "The line item being returned in an order.", "x-release-status": "BETA", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID for this return line-item entry.", "maxLength": 60, "nullable": true}, "source_line_item_uid": {"type": "string", "description": "The `uid` of the line item in the original sale order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The quantity returned, formatted as a decimal number.\nFor example, `"3"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "The note of the return line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this return line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "return_modifiers": {"type": "array", "items": {"type": "object", "description": "A line item modifier being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return modifier only within this order.", "maxLength": 60, "nullable": true}, "source_modifier_uid": {"type": "string", "description": "The modifier `uid` from the order\'s line item that contains the\noriginal sale of this line item modifier.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_return_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnServiceCharge` entities applied to the return\nline item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that\nreferences the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line\nitem. On reads, the applied amount is populated.", "nullable": true}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "A collection of line items that are being returned.", "nullable": true}, "return_service_charges": {"type": "array", "items": {"type": "object", "description": "Represents the service charge applied to the original order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "source_service_charge_uid": {"type": "string", "description": "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 255, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `"7.25"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated.", "x-release-status": "BETA", "nullable": true}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A collection of service charges that are being returned.", "nullable": true}, "return_taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned tax only within this order.", "maxLength": 60, "nullable": true}, "source_tax_uid": {"type": "string", "description": "The tax `uid` from the order that contains the original tax charge.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `"7.25"` corresponds to a percentage of 7.25%.", "maxLength": 10, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder.", "readOnly": true}, "return_discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned discount only within this order.", "maxLength": 60, "nullable": true}, "source_discount_uid": {"type": "string", "description": "The discount `uid` from the order that contains the original application of this discount.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nA value of `"7.25"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order.", "readOnly": true}, "return_tips": {"type": "array", "items": {"type": "object", "description": "A tip being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tip only within this order.", "maxLength": 60, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "source_tender_uid": {"type": "string", "description": "The tender `uid` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}, "source_tender_id": {"type": "string", "description": "The tender `id` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}}}, "description": "A collection of references to tips being returned for an order.", "nullable": true}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced.", "readOnly": true, "x-release-status": "BETA"}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "net_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "tenders": {"type": "array", "items": {"type": "object", "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"id": {"type": "string", "description": "The tender\'s unique ID. It is the associated payment ID.", "maxLength": 192}, "location_id": {"type": "string", "description": "The ID of the transaction\'s associated location.", "maxLength": 50, "nullable": true}, "transaction_id": {"type": "string", "description": "The ID of the tender\'s associated transaction.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the tender was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "note": {"type": "string", "description": "An optional note associated with the tender at the time of payment.", "maxLength": 500, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_id": {"type": "string", "description": "If the tender is associated with a customer or represents a customer\'s card on file,\nthis is the ID of the associated customer.", "maxLength": 191, "nullable": true}, "type": {"type": "string", "enum": ["CARD", "CASH", "THIRD_PARTY_CARD", "SQUARE_GIFT_CARD", "NO_SALE", "BANK_ACCOUNT", "WALLET", "BUY_NOW_PAY_LATER", "SQUARE_ACCOUNT", "OTHER"], "x-enum-elements": [{"name": "CARD", "description": "A credit card."}, {"name": "CASH", "description": "Cash."}, {"name": "THIRD_PARTY_CARD", "description": "A credit card processed with a card processor other than Square.\n\nThis value applies only to merchants in countries where Square does not\nyet provide card processing."}, {"name": "SQUARE_GIFT_CARD", "description": "A Square gift card."}, {"name": "NO_SALE", "description": "This tender represents the register being opened for a "no sale" event."}, {"name": "BANK_ACCOUNT", "description": "A bank account payment."}, {"name": "WALLET", "description": "A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,\nAu Pay, D Barai, Merpay, Wechat Pay, Alipay.\n\nNote: Some "digital wallets", including Google Pay and Apple Pay, facilitate\ncard payments.  Those payments have the `CARD` type."}, {"name": "BUY_NOW_PAY_LATER", "description": "A Buy Now Pay Later payment."}, {"name": "SQUARE_ACCOUNT", "description": "A Square House Account payment."}, {"name": "OTHER", "description": "A form of tender that does not match any other value."}], "description": "Indicates a tender\'s type.", "x-release-status": "PUBLIC"}, "card_details": {"type": "object", "description": "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The card transaction has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The card transaction was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The card transaction was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The card transaction failed."}], "description": "Indicates the card transaction\'s current status.", "x-release-status": "PUBLIC"}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}, "entry_method": {"type": "string", "enum": ["SWIPED", "KEYED", "EMV", "ON_FILE", "CONTACTLESS"], "x-enum-elements": [{"name": "SWIPED", "description": "The card was swiped through a Square reader or Square stand."}, {"name": "KEYED", "description": "The card information was keyed manually into Square Point of Sale or a\nSquare-hosted web form."}, {"name": "EMV", "description": "The card was processed via EMV with a Square reader."}, {"name": "ON_FILE", "description": "The buyer\'s card details were already on file with Square."}, {"name": "CONTACTLESS", "description": "The card was processed via a contactless (i.e., NFC) transaction\nwith a Square reader."}], "description": "Indicates the method used to enter the card\'s details.", "x-release-status": "PUBLIC"}}}, "cash_details": {"type": "object", "description": "Represents the details of a tender with `type` `CASH`.", "x-release-status": "PUBLIC", "properties": {"buyer_tendered_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "bank_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](entity:BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["PENDING", "COMPLETED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The bank account payment is in progress."}, {"name": "COMPLETED", "description": "The bank account payment has been completed."}, {"name": "FAILED", "description": "The bank account payment failed."}], "description": "Indicates the bank account payment\'s current status.", "x-release-status": "PUBLIC"}}}, "buy_now_pay_later_details": {"type": "object", "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", "x-release-status": "PUBLIC", "properties": {"buy_now_pay_later_brand": {"type": "string", "enum": ["OTHER_BRAND", "AFTERPAY"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "AFTERPAY", "description": ""}], "x-release-status": "PUBLIC"}, "status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The buy now pay later payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The buy now pay later payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The buy now pay later payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The buy now pay later payment failed."}], "x-release-status": "PUBLIC"}}}, "square_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The Square Account payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The Square Account payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The Square Account payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The Square Account payment failed."}], "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the [Payment](entity:Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API.", "maxLength": 192, "nullable": true}}}, "description": "The tenders that were used to pay for the order.", "readOnly": true, "x-release-status": "BETA"}, "refunds": {"type": "array", "items": {"type": "object", "description": "Represents a refund processed for a Square transaction.", "x-release-status": "PUBLIC", "required": ["id", "location_id", "reason", "amount_money", "status"], "properties": {"id": {"type": "string", "description": "The refund\'s unique ID.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the refund\'s associated location.", "maxLength": 50}, "transaction_id": {"type": "string", "description": "The ID of the transaction that the refunded tender is part of.", "maxLength": 192, "nullable": true}, "tender_id": {"type": "string", "description": "The ID of the refunded tender.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the refund was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "reason": {"type": "string", "description": "The reason for the refund being issued.", "maxLength": 192}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["PENDING", "APPROVED", "REJECTED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The refund is pending."}, {"name": "APPROVED", "description": "The refund has been approved by Square."}, {"name": "REJECTED", "description": "The refund has been rejected by Square."}, {"name": "FAILED", "description": "The refund failed."}], "description": "Indicates a refund\'s current status.", "x-release-status": "PUBLIC"}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}}}, "description": "The refunds that are part of this order.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "closed_at": {"type": "string", "description": "The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z").", "readOnly": true}, "state": {"type": "string", "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"], "x-enum-elements": [{"name": "OPEN", "description": "Indicates that the order is open. Open orders can be updated."}, {"name": "COMPLETED", "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state."}, {"name": "CANCELED", "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state."}, {"name": "DRAFT", "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)."}], "description": "The state of the order.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).", "x-release-status": "BETA"}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ticket_name": {"type": "string", "description": "A short-term identifier for the order (such as a customer first name,\ntable number, or auto-generated order number that resets daily).", "maxLength": 30, "x-release-status": "BETA", "nullable": true}, "pricing_options": {"type": "object", "description": "Pricing options for an order. The options affect how the order\'s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](entity:CatalogPricingRule).", "x-release-status": "PUBLIC", "properties": {"auto_apply_discounts": {"type": "boolean", "description": "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order.", "nullable": true}, "auto_apply_taxes": {"type": "boolean", "description": "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met.", "x-release-status": "BETA", "nullable": true}}}, "rewards": {"type": "array", "items": {"type": "object", "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", "x-release-status": "BETA", "required": ["id", "reward_tier_id"], "properties": {"id": {"type": "string", "description": "The identifier of the reward.", "minLength": 1}, "reward_tier_id": {"type": "string", "description": "The identifier of the reward tier corresponding to this reward.", "minLength": 1}}}, "description": "A set-like list of Rewards that have been added to the Order.", "readOnly": true, "x-release-status": "BETA"}, "net_amount_due_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "idempotency_key": {"type": "string", "description": "A value you specify that uniquely identifies this\norder among orders you have created.\n\nIf you are unsure whether a particular order was created successfully,\nyou can try it again with the same idempotency key without\nworrying about creating duplicate orders.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 192}}, "example": {"idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", "order": {"discounts": [{"name": "Labor Day Sale", "percentage": "5", "scope": "ORDER", "uid": "labor-day-sale"}, {"catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", "scope": "ORDER", "uid": "membership-discount"}, {"amount_money": {"amount": 100, "currency": "USD"}, "name": "Sale - $1.00 off", "scope": "LINE_ITEM", "uid": "one-dollar-off"}], "line_items": [{"base_price_money": {"amount": 1599, "currency": "USD"}, "name": "New York Strip Steak", "quantity": "1"}, {"applied_discounts": [{"discount_uid": "one-dollar-off"}], "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", "modifiers": [{"catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"}], "quantity": "2"}], "location_id": "057P5VYJ4A5X1", "reference_id": "my-order-001", "taxes": [{"name": "State Sales Tax", "percentage": "9", "scope": "ORDER", "uid": "state-sales-tax"}]}}}',  # noqa: E501
    "PREVIEWORDERPRICING": '{"type": "object", "x-release-status": "BETA", "required": ["order"], "properties": {"order": {"type": "object", "description": "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data.", "x-release-status": "PUBLIC", "required": ["location_id"], "properties": {"id": {"type": "string", "description": "The order\'s unique ID.", "readOnly": true}, "location_id": {"type": "string", "description": "The ID of the seller location that this order is associated with.", "minLength": 1}, "reference_id": {"type": "string", "description": "A client-specified ID to associate an entity in another system\nwith this order.", "maxLength": 40, "nullable": true}, "source": {"type": "object", "description": "Represents the origination details of an order.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order.", "nullable": true}}}, "customer_id": {"type": "string", "description": "The ID of the [customer](entity:Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "maxLength": 191, "x-release-status": "BETA", "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details.", "x-release-status": "PUBLIC", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the line item only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The count, or measurement, of a line item being purchased:\n\nIf `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count.  For example: `3` apples.\n\nIf `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement.  For example: `2.25` pounds of broccoli.\n\nFor more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).\n\nLine items with a quantity of `0` are automatically removed\nwhen paying for or otherwise completing the order.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "An optional note associated with the line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "modifiers": {"type": "array", "items": {"type": "object", "description": "A [CatalogModifier](entity:CatalogModifier).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the modifier only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount.", "x-release-status": "BETA", "nullable": true}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to service charges applied to this line item. Each\n`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a\ntop-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is\npopulated.\n\nTo change the amount of a service charge, modify the referenced top-level service charge.", "x-release-status": "BETA", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_sales_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_blocklists": {"type": "object", "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", "x-release-status": "BETA", "properties": {"blocked_discounts": {"type": "array", "items": {"type": "object", "description": "A discount to block from applying to a line item. The discount must be\nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedDiscount` within the order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that should be blocked. Use this field to block\nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "discount_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the discount that should be blocked.\nUse this field to block catalog discounts. For ad hoc discounts, use the\n`discount_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of discounts blocked from applying to the line item.\nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or\nthe `discount_catalog_object_id` (for catalog discounts).", "nullable": true}, "blocked_taxes": {"type": "array", "items": {"type": "object", "description": "A tax to block from applying to a line item. The tax must be\nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedTax` within the order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax that should be blocked. Use this field to block\nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "tax_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the tax that should be blocked.\nUse this field to block catalog taxes. For ad hoc taxes, use the\n`tax_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of taxes blocked from applying to the line item.\nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or\nthe `tax_catalog_object_id` (for catalog taxes).", "nullable": true}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The line items included in the order.", "nullable": true}, "taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tax only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `"7.25"` corresponds to a percentage of\n7.25%.", "maxLength": 10, "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}, "auto_applied": {"type": "boolean", "description": "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see\n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).", "readOnly": true, "x-release-status": "BETA"}}}, "description": "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead.", "nullable": true}, "discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the discount only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}, "reward_ids": {"type": "array", "items": {"type": "string"}, "description": "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API.", "readOnly": true, "x-release-status": "BETA"}, "pricing_rule_id": {"type": "string", "description": "The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "readOnly": true}}}, "description": "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead.", "nullable": true}, "service_charges": {"type": "array", "items": {"type": "object", "description": "Represents a service charge applied to an order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 512, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The service charge percentage as a string representation of a\ndecimal number. For example, `"7.25"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["AUTO_GRATUITY", "CUSTOM"], "x-enum-elements": [{"name": "AUTO_GRATUITY", "description": ""}, {"name": "CUSTOM", "description": ""}], "x-release-status": "PUBLIC"}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A list of service charges applied to the order.", "nullable": true}, "fulfillments": {"type": "array", "items": {"type": "object", "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["PICKUP", "SHIPMENT", "DELIVERY"], "x-enum-elements": [{"name": "PICKUP", "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)."}, {"name": "SHIPMENT", "description": "A shipping carrier to ship the fulfillment."}, {"name": "DELIVERY", "description": "A courier to deliver the fulfillment."}], "description": "The type of fulfillment.", "x-release-status": "PUBLIC"}, "state": {"type": "string", "enum": ["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], "x-enum-elements": [{"name": "PROPOSED", "description": "Indicates that the fulfillment has been proposed."}, {"name": "RESERVED", "description": "Indicates that the fulfillment has been reserved."}, {"name": "PREPARED", "description": "Indicates that the fulfillment has been prepared."}, {"name": "COMPLETED", "description": "Indicates that the fulfillment was successfully completed."}, {"name": "CANCELED", "description": "Indicates that the fulfillment was canceled."}, {"name": "FAILED", "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled."}], "description": "The current state of this fulfillment.", "x-release-status": "PUBLIC"}, "line_item_application": {"type": "string", "enum": ["ALL", "ENTRY_LIST"], "x-enum-elements": [{"name": "ALL", "description": "If `ALL`, `entries` must be unset."}, {"name": "ENTRY_LIST", "description": "If `ENTRY_LIST`, supply a list of `entries`."}], "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", "x-release-status": "BETA"}, "entries": {"type": "array", "items": {"type": "object", "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", "x-release-status": "BETA", "required": ["line_item_uid", "quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment entry only within this order.", "maxLength": 60, "nullable": true}, "line_item_uid": {"type": "string", "description": "The `uid` from the order line item.", "minLength": 1}, "quantity": {"type": "string", "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `"3"`.\n\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "nullable": true}}}, "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\n\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder\'s line item itself.\n\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "pickup_details": {"type": "object", "description": "Contains details necessary to fulfill a pickup order.", "x-release-status": "PUBLIC", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "expires_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", "nullable": true}, "auto_complete_duration": {"type": "string", "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", "nullable": true}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time."}, {"name": "ASAP", "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately."}], "description": "The schedule type of the pickup fulfillment.", "x-release-status": "PUBLIC"}, "pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n"2016-09-04T23:59:33.123Z".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", "nullable": true}, "pickup_window_duration": {"type": "string", "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an\ninformational guideline for merchants.", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", "maxLength": 500, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "accepted_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expired_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "picked_up_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", "maxLength": 100, "nullable": true}, "is_curbside_pickup": {"type": "boolean", "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", "x-release-status": "BETA", "nullable": true}, "curbside_pickup_details": {"type": "object", "description": "Specific details for curbside pickup.", "x-release-status": "BETA", "properties": {"curbside_details": {"type": "string", "description": "Specific details for curbside pickup, such as parking number and vehicle model.", "maxLength": 250, "nullable": true}, "buyer_arrived_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}}}}}, "shipment_details": {"type": "object", "description": "Contains the details necessary to fulfill a shipment order.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "carrier": {"type": "string", "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", "maxLength": 50, "nullable": true}, "shipping_note": {"type": "string", "description": "A note with additional information for the shipping carrier.", "maxLength": 500, "nullable": true}, "shipping_type": {"type": "string", "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", "maxLength": 50, "nullable": true}, "tracking_number": {"type": "string", "description": "The reference number provided by the carrier to track the shipment\'s progress.", "maxLength": 100, "nullable": true}, "tracking_url": {"type": "string", "description": "A link to the tracking webpage on the carrier\'s website.", "maxLength": 2000, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "packaged_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expected_shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "cancel_reason": {"type": "string", "description": "A description of why the shipment was canceled.", "maxLength": 100, "nullable": true}, "failed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "failure_reason": {"type": "string", "description": "A description of why the shipment failed to be completed.", "maxLength": 100, "nullable": true}}}, "delivery_details": {"type": "object", "description": "Describes delivery details of an order fulfillment.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates the fulfillment to deliver at a scheduled deliver time."}, {"name": "ASAP", "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately."}], "description": "The schedule type of the delivery fulfillment.", "x-release-status": "BETA"}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").\n\nMust be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".", "readOnly": true}, "deliver_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "delivery_window_duration": {"type": "string", "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", "maxLength": 550, "nullable": true}, "completed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when  fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "delivered_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "The delivery cancellation reason. Max length: 100 characters.", "maxLength": 100, "nullable": true}, "courier_pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "courier_pickup_window_duration": {"type": "string", "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "is_no_contact_delivery": {"type": "boolean", "description": "Whether the delivery is preferred to be no contact.", "nullable": true}, "dropoff_notes": {"type": "string", "description": "A note to provide additional instructions about how to deliver the order.", "maxLength": 550, "nullable": true}, "courier_provider_name": {"type": "string", "description": "The name of the courier provider.", "maxLength": 255, "nullable": true}, "courier_support_phone_number": {"type": "string", "description": "The support phone number of the courier.", "maxLength": 17, "nullable": true}, "square_delivery_id": {"type": "string", "description": "The identifier for the delivery created by Square.", "maxLength": 50, "nullable": true}, "external_delivery_id": {"type": "string", "description": "The identifier for the delivery created by the third-party courier service.", "maxLength": 50, "nullable": true}, "managed_delivery": {"type": "boolean", "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", "nullable": true}}}}}, "description": "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments.", "nullable": true}, "returns": {"type": "array", "items": {"type": "object", "description": "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return only within this order.", "maxLength": 60, "nullable": true}, "source_order_id": {"type": "string", "description": "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns.", "nullable": true}, "return_line_items": {"type": "array", "items": {"type": "object", "description": "The line item being returned in an order.", "x-release-status": "BETA", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID for this return line-item entry.", "maxLength": 60, "nullable": true}, "source_line_item_uid": {"type": "string", "description": "The `uid` of the line item in the original sale order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The quantity returned, formatted as a decimal number.\nFor example, `"3"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "The note of the return line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this return line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "return_modifiers": {"type": "array", "items": {"type": "object", "description": "A line item modifier being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return modifier only within this order.", "maxLength": 60, "nullable": true}, "source_modifier_uid": {"type": "string", "description": "The modifier `uid` from the order\'s line item that contains the\noriginal sale of this line item modifier.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_return_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnServiceCharge` entities applied to the return\nline item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that\nreferences the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line\nitem. On reads, the applied amount is populated.", "nullable": true}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "A collection of line items that are being returned.", "nullable": true}, "return_service_charges": {"type": "array", "items": {"type": "object", "description": "Represents the service charge applied to the original order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "source_service_charge_uid": {"type": "string", "description": "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 255, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `"7.25"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated.", "x-release-status": "BETA", "nullable": true}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A collection of service charges that are being returned.", "nullable": true}, "return_taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned tax only within this order.", "maxLength": 60, "nullable": true}, "source_tax_uid": {"type": "string", "description": "The tax `uid` from the order that contains the original tax charge.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `"7.25"` corresponds to a percentage of 7.25%.", "maxLength": 10, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder.", "readOnly": true}, "return_discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned discount only within this order.", "maxLength": 60, "nullable": true}, "source_discount_uid": {"type": "string", "description": "The discount `uid` from the order that contains the original application of this discount.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nA value of `"7.25"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order.", "readOnly": true}, "return_tips": {"type": "array", "items": {"type": "object", "description": "A tip being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tip only within this order.", "maxLength": 60, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "source_tender_uid": {"type": "string", "description": "The tender `uid` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}, "source_tender_id": {"type": "string", "description": "The tender `id` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}}}, "description": "A collection of references to tips being returned for an order.", "nullable": true}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced.", "readOnly": true, "x-release-status": "BETA"}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "net_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "tenders": {"type": "array", "items": {"type": "object", "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"id": {"type": "string", "description": "The tender\'s unique ID. It is the associated payment ID.", "maxLength": 192}, "location_id": {"type": "string", "description": "The ID of the transaction\'s associated location.", "maxLength": 50, "nullable": true}, "transaction_id": {"type": "string", "description": "The ID of the tender\'s associated transaction.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the tender was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "note": {"type": "string", "description": "An optional note associated with the tender at the time of payment.", "maxLength": 500, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_id": {"type": "string", "description": "If the tender is associated with a customer or represents a customer\'s card on file,\nthis is the ID of the associated customer.", "maxLength": 191, "nullable": true}, "type": {"type": "string", "enum": ["CARD", "CASH", "THIRD_PARTY_CARD", "SQUARE_GIFT_CARD", "NO_SALE", "BANK_ACCOUNT", "WALLET", "BUY_NOW_PAY_LATER", "SQUARE_ACCOUNT", "OTHER"], "x-enum-elements": [{"name": "CARD", "description": "A credit card."}, {"name": "CASH", "description": "Cash."}, {"name": "THIRD_PARTY_CARD", "description": "A credit card processed with a card processor other than Square.\n\nThis value applies only to merchants in countries where Square does not\nyet provide card processing."}, {"name": "SQUARE_GIFT_CARD", "description": "A Square gift card."}, {"name": "NO_SALE", "description": "This tender represents the register being opened for a "no sale" event."}, {"name": "BANK_ACCOUNT", "description": "A bank account payment."}, {"name": "WALLET", "description": "A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,\nAu Pay, D Barai, Merpay, Wechat Pay, Alipay.\n\nNote: Some "digital wallets", including Google Pay and Apple Pay, facilitate\ncard payments.  Those payments have the `CARD` type."}, {"name": "BUY_NOW_PAY_LATER", "description": "A Buy Now Pay Later payment."}, {"name": "SQUARE_ACCOUNT", "description": "A Square House Account payment."}, {"name": "OTHER", "description": "A form of tender that does not match any other value."}], "description": "Indicates a tender\'s type.", "x-release-status": "PUBLIC"}, "card_details": {"type": "object", "description": "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The card transaction has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The card transaction was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The card transaction was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The card transaction failed."}], "description": "Indicates the card transaction\'s current status.", "x-release-status": "PUBLIC"}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}, "entry_method": {"type": "string", "enum": ["SWIPED", "KEYED", "EMV", "ON_FILE", "CONTACTLESS"], "x-enum-elements": [{"name": "SWIPED", "description": "The card was swiped through a Square reader or Square stand."}, {"name": "KEYED", "description": "The card information was keyed manually into Square Point of Sale or a\nSquare-hosted web form."}, {"name": "EMV", "description": "The card was processed via EMV with a Square reader."}, {"name": "ON_FILE", "description": "The buyer\'s card details were already on file with Square."}, {"name": "CONTACTLESS", "description": "The card was processed via a contactless (i.e., NFC) transaction\nwith a Square reader."}], "description": "Indicates the method used to enter the card\'s details.", "x-release-status": "PUBLIC"}}}, "cash_details": {"type": "object", "description": "Represents the details of a tender with `type` `CASH`.", "x-release-status": "PUBLIC", "properties": {"buyer_tendered_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "bank_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](entity:BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["PENDING", "COMPLETED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The bank account payment is in progress."}, {"name": "COMPLETED", "description": "The bank account payment has been completed."}, {"name": "FAILED", "description": "The bank account payment failed."}], "description": "Indicates the bank account payment\'s current status.", "x-release-status": "PUBLIC"}}}, "buy_now_pay_later_details": {"type": "object", "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", "x-release-status": "PUBLIC", "properties": {"buy_now_pay_later_brand": {"type": "string", "enum": ["OTHER_BRAND", "AFTERPAY"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "AFTERPAY", "description": ""}], "x-release-status": "PUBLIC"}, "status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The buy now pay later payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The buy now pay later payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The buy now pay later payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The buy now pay later payment failed."}], "x-release-status": "PUBLIC"}}}, "square_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The Square Account payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The Square Account payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The Square Account payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The Square Account payment failed."}], "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the [Payment](entity:Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API.", "maxLength": 192, "nullable": true}}}, "description": "The tenders that were used to pay for the order.", "readOnly": true, "x-release-status": "BETA"}, "refunds": {"type": "array", "items": {"type": "object", "description": "Represents a refund processed for a Square transaction.", "x-release-status": "PUBLIC", "required": ["id", "location_id", "reason", "amount_money", "status"], "properties": {"id": {"type": "string", "description": "The refund\'s unique ID.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the refund\'s associated location.", "maxLength": 50}, "transaction_id": {"type": "string", "description": "The ID of the transaction that the refunded tender is part of.", "maxLength": 192, "nullable": true}, "tender_id": {"type": "string", "description": "The ID of the refunded tender.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the refund was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "reason": {"type": "string", "description": "The reason for the refund being issued.", "maxLength": 192}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["PENDING", "APPROVED", "REJECTED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The refund is pending."}, {"name": "APPROVED", "description": "The refund has been approved by Square."}, {"name": "REJECTED", "description": "The refund has been rejected by Square."}, {"name": "FAILED", "description": "The refund failed."}], "description": "Indicates a refund\'s current status.", "x-release-status": "PUBLIC"}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}}}, "description": "The refunds that are part of this order.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "closed_at": {"type": "string", "description": "The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z").", "readOnly": true}, "state": {"type": "string", "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"], "x-enum-elements": [{"name": "OPEN", "description": "Indicates that the order is open. Open orders can be updated."}, {"name": "COMPLETED", "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state."}, {"name": "CANCELED", "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state."}, {"name": "DRAFT", "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)."}], "description": "The state of the order.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).", "x-release-status": "BETA"}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ticket_name": {"type": "string", "description": "A short-term identifier for the order (such as a customer first name,\ntable number, or auto-generated order number that resets daily).", "maxLength": 30, "x-release-status": "BETA", "nullable": true}, "pricing_options": {"type": "object", "description": "Pricing options for an order. The options affect how the order\'s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](entity:CatalogPricingRule).", "x-release-status": "PUBLIC", "properties": {"auto_apply_discounts": {"type": "boolean", "description": "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order.", "nullable": true}, "auto_apply_taxes": {"type": "boolean", "description": "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met.", "x-release-status": "BETA", "nullable": true}}}, "rewards": {"type": "array", "items": {"type": "object", "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", "x-release-status": "BETA", "required": ["id", "reward_tier_id"], "properties": {"id": {"type": "string", "description": "The identifier of the reward.", "minLength": 1}, "reward_tier_id": {"type": "string", "description": "The identifier of the reward tier corresponding to this reward.", "minLength": 1}}}, "description": "A set-like list of Rewards that have been added to the Order.", "readOnly": true, "x-release-status": "BETA"}, "net_amount_due_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "proposed_rewards": {"type": "array", "items": {"type": "object", "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", "x-release-status": "BETA", "required": ["id", "reward_tier_id"], "properties": {"id": {"type": "string", "description": "The identifier of the reward.", "minLength": 1}, "reward_tier_id": {"type": "string", "description": "The identifier of the reward tier corresponding to this reward.", "minLength": 1}}}, "description": "Identifies one or more loyalty reward tiers to apply during the order calculation.\nThe discounts defined by the reward tiers are added to the order only to preview the\neffect of applying the specified rewards. The rewards do not correspond to actual\nredemptions; that is, no `reward`s are created. Therefore, the reward `id`s are\nrandom strings used only to reference the reward tier.", "nullable": true}}, "example": {"idempotency_key": "b3e98fe3-b8de-471c-82f1-545f371e637c", "order": {"discounts": [{"name": "50% Off", "percentage": "50", "scope": "ORDER"}], "line_items": [{"base_price_money": {"amount": 500, "currency": "USD"}, "name": "Item 1", "quantity": "1"}, {"base_price_money": {"amount": 300, "currency": "USD"}, "name": "Item 2", "quantity": "2"}], "location_id": "D7AVYMEAPJ3A3"}}}',  # noqa: E501
    "BULKDELETEORDERCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a bulk delete request for one or more order custom attributes.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents one delete within the bulk operation.", "x-release-status": "BETA", "required": ["order_id"], "properties": {"key": {"type": "string", "description": "The key of the custom attribute to delete.  This key must match the key \nof an existing custom attribute definition.", "minLength": 1, "pattern": "^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$", "readOnly": true}, "order_id": {"type": "string", "description": "The ID of the target [order](entity:Order).", "minLength": 1, "maxLength": 255}}}, "description": "A map of requests that correspond to individual delete operations for custom attributes."}}, "example": {"values": {"cover-count": {"key": "cover-count", "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"}, "table-number": {"key": "table-number", "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"}}}}',  # noqa: E501
    "BULKUPSERTORDERCUSTOMATTRIBUTES": '{"type": "object", "description": "Represents a bulk upsert request for one or more order custom attributes.", "x-release-status": "BETA", "required": ["values"], "properties": {"values": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents one upsert within the bulk operation.", "x-release-status": "BETA", "required": ["custom_attribute", "order_id"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "minLength": 1, "maxLength": 45, "nullable": true}, "order_id": {"type": "string", "description": "The ID of the target [order](entity:Order).", "minLength": 1, "maxLength": 255}}}, "description": "A map of requests that correspond to individual upsert operations for custom attributes."}}, "example": {"values": {"cover-count": {"custom_attribute": {"key": "cover-count", "value": "6", "version": 2}, "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"}, "table-number": {"custom_attribute": {"key": "table-number", "value": "11", "version": 4}, "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"}}}}',  # noqa: E501
    "SEARCHSQUAREORDERS": '{"type": "object", "x-release-status": "PUBLIC", "properties": {"location_ids": {"type": "array", "items": {"type": "string"}, "description": "The location IDs for the orders to query. All locations must belong to\nthe same merchant.\n\nMax: 10 location IDs."}, "cursor": {"type": "string", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."}, "query": {"type": "object", "description": "Contains query criteria for the search.", "x-release-status": "PUBLIC", "properties": {"filter": {"type": "object", "description": "Filtering criteria to use for a `SearchOrders` request. Multiple filters\nare ANDed together.", "x-release-status": "PUBLIC", "properties": {"state_filter": {"type": "object", "description": "Filter by the current order `state`.", "x-release-status": "PUBLIC", "required": ["states"], "properties": {"states": {"type": "array", "items": {"type": "string", "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"], "x-enum-elements": [{"name": "OPEN", "description": "Indicates that the order is open. Open orders can be updated."}, {"name": "COMPLETED", "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state."}, {"name": "CANCELED", "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state."}, {"name": "DRAFT", "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)."}], "description": "The state of the order.", "x-release-status": "PUBLIC"}, "description": "States to filter for.\nSee [OrderState](#type-orderstate) for possible values"}}}, "date_time_filter": {"type": "object", "description": "Filter for `Order` objects based on whether their `CREATED_AT`,\n`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.\nYou can specify the time range and which timestamp to filter for. You can filter\nfor only one time range at a time.\n\nFor each time range, the start time and end time are inclusive. If the end time\nis absent, it defaults to the time of the first request for the cursor.\n\n__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,\nyou must set the `sort_field` in [OrdersSort](entity:SearchOrdersSort)\nto the same field you filter for. For example, if you set the `CLOSED_AT` field\nin `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to\n`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.\n[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)", "x-release-status": "PUBLIC", "properties": {"created_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "updated_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}, "closed_at": {"type": "object", "description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled.", "x-release-status": "PUBLIC", "properties": {"start_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nstarts.", "nullable": true}, "end_at": {"type": "string", "description": "A datetime value in RFC 3339 format indicating when the time range\nends.", "nullable": true}}}}}, "fulfillment_filter": {"type": "object", "description": "Filter based on [order fulfillment](entity:Fulfillment) information.", "x-release-status": "PUBLIC", "properties": {"fulfillment_types": {"type": "array", "items": {"type": "string", "enum": ["PICKUP", "SHIPMENT", "DELIVERY"], "x-enum-elements": [{"name": "PICKUP", "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)."}, {"name": "SHIPMENT", "description": "A shipping carrier to ship the fulfillment."}, {"name": "DELIVERY", "description": "A courier to deliver the fulfillment."}], "description": "The type of fulfillment.", "x-release-status": "PUBLIC"}, "description": "A list of [fulfillment types](entity:FulfillmentType) to filter\nfor. The list returns orders if any of its fulfillments match any of the fulfillment types\nlisted in this field.\nSee [FulfillmentType](#type-fulfillmenttype) for possible values", "nullable": true}, "fulfillment_states": {"type": "array", "items": {"type": "string", "enum": ["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], "x-enum-elements": [{"name": "PROPOSED", "description": "Indicates that the fulfillment has been proposed."}, {"name": "RESERVED", "description": "Indicates that the fulfillment has been reserved."}, {"name": "PREPARED", "description": "Indicates that the fulfillment has been prepared."}, {"name": "COMPLETED", "description": "Indicates that the fulfillment was successfully completed."}, {"name": "CANCELED", "description": "Indicates that the fulfillment was canceled."}, {"name": "FAILED", "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled."}], "description": "The current state of this fulfillment.", "x-release-status": "PUBLIC"}, "description": "A list of [fulfillment states](entity:FulfillmentState) to filter\nfor. The list returns orders if any of its fulfillments match any of the\nfulfillment states listed in this field.\nSee [FulfillmentState](#type-fulfillmentstate) for possible values", "nullable": true}}}, "source_filter": {"type": "object", "description": "A filter based on order `source` information.", "x-release-status": "PUBLIC", "properties": {"source_names": {"type": "array", "items": {"type": "string"}, "description": "Filters by the [Source](entity:OrderSource) `name`. The filter returns any orders\nwith a `source.name` that matches any of the listed source names.\n\nMax: 10 source names.", "nullable": true}}}, "customer_filter": {"type": "object", "description": "A filter based on the order `customer_id` and any tender `customer_id`\nassociated with the order. It does not filter based on the\n[FulfillmentRecipient](entity:FulfillmentRecipient) `customer_id`.", "x-release-status": "BETA", "properties": {"customer_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of customer IDs to filter by.\n\nMax: 10 customer ids.", "nullable": true}}}}}, "sort": {"type": "object", "description": "Sorting criteria for a `SearchOrders` request. Results can only be sorted\nby a timestamp field.", "x-release-status": "PUBLIC", "required": ["sort_field"], "properties": {"sort_field": {"type": "string", "enum": ["CREATED_AT", "UPDATED_AT", "CLOSED_AT"], "x-enum-elements": [{"name": "CREATED_AT", "description": "The time when the order was created, in RFC-3339 format. If you are also\nfiltering for a time range in this query, you must set the `CREATED_AT`\nfield in your `DateTimeFilter`."}, {"name": "UPDATED_AT", "description": "The time when the order last updated, in RFC-3339 format. If you are also\nfiltering for a time range in this query, you must set the `UPDATED_AT`\nfield in your `DateTimeFilter`."}, {"name": "CLOSED_AT", "description": "The time when the order was closed, in RFC-3339 format. If you use this\nvalue, you must also set a `StateFilter` with closed states. If you are also\nfiltering for a time range in this query, you must set the `CLOSED_AT`\nfield in your `DateTimeFilter`."}], "description": "Specifies which timestamp to use to sort `SearchOrder` results.", "x-release-status": "PUBLIC"}, "sort_order": {"type": "string", "enum": ["DESC", "ASC"], "x-enum-elements": [{"name": "DESC", "description": "The results are returned in descending (e.g., newest-first or Z-A) order."}, {"name": "ASC", "description": "The results are returned in ascending (e.g., oldest-first or A-Z) order."}], "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.", "x-release-status": "PUBLIC"}}}}}, "limit": {"type": "integer", "description": "The maximum number of results to be returned in a single page.\n\nDefault: `500`\nMax: `1000`"}, "return_entries": {"type": "boolean", "description": "A Boolean that controls the format of the search results. If `true`,\n`SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders`\nreturns complete order objects.\n\nDefault: `false`."}}, "example": {"limit": 3, "location_ids": ["057P5VYJ4A5X1", "18YC4JDH91E1H"], "query": {"filter": {"date_time_filter": {"closed_at": {"end_at": "2019-03-04T21:54:45+00:00", "start_at": "2018-03-03T20:00:00+00:00"}}, "state_filter": {"states": ["COMPLETED"]}}, "sort": {"sort_field": "CLOSED_AT", "sort_order": "DESC"}}, "return_entries": true}}',  # noqa: E501
    "UPDATEORDERSQUARE": '{"type": "object", "description": "Defines the fields that are included in requests to the\n[UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.", "x-release-status": "BETA", "properties": {"order": {"type": "object", "description": "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data.", "x-release-status": "PUBLIC", "required": ["location_id"], "properties": {"id": {"type": "string", "description": "The order\'s unique ID.", "readOnly": true}, "location_id": {"type": "string", "description": "The ID of the seller location that this order is associated with.", "minLength": 1}, "reference_id": {"type": "string", "description": "A client-specified ID to associate an entity in another system\nwith this order.", "maxLength": 40, "nullable": true}, "source": {"type": "object", "description": "Represents the origination details of an order.", "x-release-status": "PUBLIC", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order.", "nullable": true}}}, "customer_id": {"type": "string", "description": "The ID of the [customer](entity:Customer) associated with the order.\n\nYou should specify a `customer_id` on the order (or the payment) to ensure that transactions\nare reliably linked to customers. Omitting this field might result in the creation of new\n[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).", "maxLength": 191, "x-release-status": "BETA", "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details.", "x-release-status": "PUBLIC", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the line item only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The count, or measurement, of a line item being purchased:\n\nIf `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count.  For example: `3` apples.\n\nIf `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement.  For example: `2.25` pounds of broccoli.\n\nFor more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).\n\nLine items with a quantity of `0` are automatically removed\nwhen paying for or otherwise completing the order.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "An optional note associated with the line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "modifiers": {"type": "array", "items": {"type": "object", "description": "A [CatalogModifier](entity:CatalogModifier).", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the modifier only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount.", "x-release-status": "BETA", "nullable": true}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to service charges applied to this line item. Each\n`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a\ntop-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is\npopulated.\n\nTo change the amount of a service charge, modify the referenced top-level service charge.", "x-release-status": "BETA", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_sales_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "pricing_blocklists": {"type": "object", "description": "Describes pricing adjustments that are blocked from automatic\napplication to a line item. For more information, see\n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).", "x-release-status": "BETA", "properties": {"blocked_discounts": {"type": "array", "items": {"type": "object", "description": "A discount to block from applying to a line item. The discount must be\nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedDiscount` within the order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that should be blocked. Use this field to block\nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "discount_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the discount that should be blocked.\nUse this field to block catalog discounts. For ad hoc discounts, use the\n`discount_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of discounts blocked from applying to the line item.\nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or\nthe `discount_catalog_object_id` (for catalog discounts).", "nullable": true}, "blocked_taxes": {"type": "array", "items": {"type": "object", "description": "A tax to block from applying to a line item. The tax must be\nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID of the `BlockedTax` within the order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax that should be blocked. Use this field to block\nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.", "maxLength": 60, "nullable": true}, "tax_catalog_object_id": {"type": "string", "description": "The `catalog_object_id` of the tax that should be blocked.\nUse this field to block catalog taxes. For ad hoc taxes, use the\n`tax_uid` field.", "maxLength": 192, "nullable": true}}}, "description": "A list of taxes blocked from applying to the line item.\nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or\nthe `tax_catalog_object_id` (for catalog taxes).", "nullable": true}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The line items included in the order.", "nullable": true}, "taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tax only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `"7.25"` corresponds to a percentage of\n7.25%.", "maxLength": 10, "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}, "auto_applied": {"type": "boolean", "description": "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see\n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes).", "readOnly": true, "x-release-status": "BETA"}}}, "description": "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead.", "nullable": true}, "discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the discount only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}, "reward_ids": {"type": "array", "items": {"type": "string"}, "description": "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API.", "readOnly": true, "x-release-status": "BETA"}, "pricing_rule_id": {"type": "string", "description": "The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied\nautomatically to this discount. The specification and application of the discounts, to\nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding\npricing rule.", "readOnly": true}}}, "description": "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead.", "nullable": true}, "service_charges": {"type": "array", "items": {"type": "object", "description": "Represents a service charge applied to an order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 512, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The service charge percentage as a string representation of a\ndecimal number. For example, `"7.25"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax.", "x-release-status": "BETA", "nullable": true}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["AUTO_GRATUITY", "CUSTOM"], "x-enum-elements": [{"name": "AUTO_GRATUITY", "description": ""}, {"name": "CUSTOM", "description": ""}], "x-release-status": "PUBLIC"}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A list of service charges applied to the order.", "nullable": true}, "fulfillments": {"type": "array", "items": {"type": "object", "description": "Contains details about how to fulfill this order.\nOrders can only be created with at most one fulfillment using the API.\nHowever, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "type": {"type": "string", "enum": ["PICKUP", "SHIPMENT", "DELIVERY"], "x-enum-elements": [{"name": "PICKUP", "description": "A recipient to pick up the fulfillment from a physical [location](entity:Location)."}, {"name": "SHIPMENT", "description": "A shipping carrier to ship the fulfillment."}, {"name": "DELIVERY", "description": "A courier to deliver the fulfillment."}], "description": "The type of fulfillment.", "x-release-status": "PUBLIC"}, "state": {"type": "string", "enum": ["PROPOSED", "RESERVED", "PREPARED", "COMPLETED", "CANCELED", "FAILED"], "x-enum-elements": [{"name": "PROPOSED", "description": "Indicates that the fulfillment has been proposed."}, {"name": "RESERVED", "description": "Indicates that the fulfillment has been reserved."}, {"name": "PREPARED", "description": "Indicates that the fulfillment has been prepared."}, {"name": "COMPLETED", "description": "Indicates that the fulfillment was successfully completed."}, {"name": "CANCELED", "description": "Indicates that the fulfillment was canceled."}, {"name": "FAILED", "description": "Indicates that the fulfillment failed to be completed, but was not explicitly\ncanceled."}], "description": "The current state of this fulfillment.", "x-release-status": "PUBLIC"}, "line_item_application": {"type": "string", "enum": ["ALL", "ENTRY_LIST"], "x-enum-elements": [{"name": "ALL", "description": "If `ALL`, `entries` must be unset."}, {"name": "ENTRY_LIST", "description": "If `ENTRY_LIST`, supply a list of `entries`."}], "description": "The `line_item_application` describes what order line items this fulfillment applies\nto. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.", "x-release-status": "BETA"}, "entries": {"type": "array", "items": {"type": "object", "description": "Links an order line item to a fulfillment. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.", "x-release-status": "BETA", "required": ["line_item_uid", "quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the fulfillment entry only within this order.", "maxLength": 60, "nullable": true}, "line_item_uid": {"type": "string", "description": "The `uid` from the order line item.", "minLength": 1}, "quantity": {"type": "string", "description": "The quantity of the line item being fulfilled, formatted as a decimal number.\nFor example, `"3"`.\n\nFulfillments for line items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment entry. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "nullable": true}}}, "description": "A list of entries pertaining to the fulfillment of an order. Each entry must reference\na valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to\nfulfill.\n\nMultiple entries can reference the same line item `uid`, as long as the total quantity among\nall fulfillment entries referencing a single line item does not exceed the quantity of the\norder\'s line item itself.\n\nAn order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,\n`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently\nbefore order completion.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "pickup_details": {"type": "object", "description": "Contains details necessary to fulfill a pickup order.", "x-release-status": "PUBLIC", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "expires_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment expires if it is not marked in progress. The timestamp must be\nin RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set\nup to 7 days in the future. If `expires_at` is not set, any new payments attached to the order\nare automatically completed.", "nullable": true}, "auto_complete_duration": {"type": "string", "description": "The duration of time after which an in progress pickup fulfillment is automatically moved\nto the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").\n\nIf not set, this pickup fulfillment remains in progress until it is canceled or completed.", "nullable": true}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates that the fulfillment will be picked up at a scheduled pickup time."}, {"name": "ASAP", "description": "Indicates that the fulfillment will be picked up as soon as possible and\nshould be prepared immediately."}], "description": "The schedule type of the pickup fulfillment.", "x-release-status": "PUBLIC"}, "pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,\n"2016-09-04T23:59:33.123Z".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment.", "nullable": true}, "pickup_window_duration": {"type": "string", "description": "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an\ninformational guideline for merchants.", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "A note to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API.", "maxLength": 500, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "accepted_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expired_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "picked_up_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "A description of why the pickup was canceled. The maximum length: 100 characters.", "maxLength": 100, "nullable": true}, "is_curbside_pickup": {"type": "boolean", "description": "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.", "x-release-status": "BETA", "nullable": true}, "curbside_pickup_details": {"type": "object", "description": "Specific details for curbside pickup.", "x-release-status": "BETA", "properties": {"curbside_details": {"type": "string", "description": "Specific details for curbside pickup, such as parking number and vehicle model.", "maxLength": 250, "nullable": true}, "buyer_arrived_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}}}}}, "shipment_details": {"type": "object", "description": "Contains the details necessary to fulfill a shipment order.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "carrier": {"type": "string", "description": "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).", "maxLength": 50, "nullable": true}, "shipping_note": {"type": "string", "description": "A note with additional information for the shipping carrier.", "maxLength": 500, "nullable": true}, "shipping_type": {"type": "string", "description": "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express).", "maxLength": 50, "nullable": true}, "tracking_number": {"type": "string", "description": "The reference number provided by the carrier to track the shipment\'s progress.", "maxLength": 100, "nullable": true}, "tracking_url": {"type": "string", "description": "A link to the tracking webpage on the carrier\'s website.", "maxLength": 2000, "nullable": true}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which  indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "packaged_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "expected_shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "shipped_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "cancel_reason": {"type": "string", "description": "A description of why the shipment was canceled.", "maxLength": 100, "nullable": true}, "failed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "failure_reason": {"type": "string", "description": "A description of why the shipment failed to be completed.", "maxLength": 100, "nullable": true}}}, "delivery_details": {"type": "object", "description": "Describes delivery details of an order fulfillment.", "x-release-status": "BETA", "properties": {"recipient": {"type": "object", "description": "Information about the fulfillment recipient.", "x-release-status": "PUBLIC", "properties": {"customer_id": {"type": "string", "description": "The ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient\'s `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues override the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error.", "maxLength": 191, "nullable": true}, "display_name": {"type": "string", "description": "The display name of the fulfillment recipient. This field is required.\n\nIf provided, the display name overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the fulfillment recipient. This field is required.\n\nIf provided, the phone number overrides the corresponding customer profile value\nindicated by `customer_id`.", "maxLength": 17, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}}}, "schedule_type": {"type": "string", "enum": ["SCHEDULED", "ASAP"], "x-enum-elements": [{"name": "SCHEDULED", "description": "Indicates the fulfillment to deliver at a scheduled deliver time."}, {"name": "ASAP", "description": "Indicates that the fulfillment to deliver as soon as possible and should be prepared\nimmediately."}], "description": "The schedule type of the delivery fulfillment.", "x-release-status": "BETA"}, "placed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was placed.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").\n\nMust be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z".", "readOnly": true}, "deliver_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nthat represents the start of the delivery period.\nWhen the fulfillment `schedule_type` is `ASAP`, the field is automatically\nset to the current time plus the `prep_time_duration`.\nOtherwise, the application can set this field while the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the\nterminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe timestamp must be in RFC 3339 format\n(for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "prep_time_duration": {"type": "string", "description": "The duration of time it takes to prepare and deliver this fulfillment.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "delivery_window_duration": {"type": "string", "description": "The time period after `deliver_at` in which to deliver the order.\nApplications can set this field when the fulfillment `state` is\n`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state\nsuch as `COMPLETED`, `CANCELED`, and `FAILED`).\n\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "note": {"type": "string", "description": "Provides additional instructions about the delivery fulfillment.\nIt is displayed in the Square Point of Sale application and set by the API.", "maxLength": 550, "nullable": true}, "completed_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller completed the fulfillment.\nThis field is automatically set when  fulfillment `state` changes to `COMPLETED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "in_progress_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicates when the seller started processing the fulfillment.\nThis field is automatically set when the fulfillment `state` changes to `RESERVED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "rejected_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was rejected. This field is\nautomatically set when the fulfillment `state` changes to `FAILED`.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "ready_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the seller marked the fulfillment as ready for\ncourier pickup. This field is automatically set when the fulfillment `state` changes\nto PREPARED.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "delivered_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was delivered to the recipient.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "canceled_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was canceled. This field is automatically\nset when the fulfillment `state` changes to `CANCELED`.\n\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "cancel_reason": {"type": "string", "description": "The delivery cancellation reason. Max length: 100 characters.", "maxLength": 100, "nullable": true}, "courier_pickup_at": {"type": "string", "description": "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when an order can be picked up by the courier for delivery.\nThe timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "nullable": true}, "courier_pickup_window_duration": {"type": "string", "description": "The time period after `courier_pickup_at` in which the courier should pick up the order.\nThe duration must be in RFC 3339 format (for example, "P1W3D").", "nullable": true}, "is_no_contact_delivery": {"type": "boolean", "description": "Whether the delivery is preferred to be no contact.", "nullable": true}, "dropoff_notes": {"type": "string", "description": "A note to provide additional instructions about how to deliver the order.", "maxLength": 550, "nullable": true}, "courier_provider_name": {"type": "string", "description": "The name of the courier provider.", "maxLength": 255, "nullable": true}, "courier_support_phone_number": {"type": "string", "description": "The support phone number of the courier.", "maxLength": 17, "nullable": true}, "square_delivery_id": {"type": "string", "description": "The identifier for the delivery created by Square.", "maxLength": 50, "nullable": true}, "external_delivery_id": {"type": "string", "description": "The identifier for the delivery created by the third-party courier service.", "maxLength": 50, "nullable": true}, "managed_delivery": {"type": "boolean", "description": "The flag to indicate the delivery is managed by a third party (ie DoorDash), which means\nwe may not receive all recipient information for PII purposes.", "nullable": true}}}}}, "description": "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments.", "nullable": true}, "returns": {"type": "array", "items": {"type": "object", "description": "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return only within this order.", "maxLength": 60, "nullable": true}, "source_order_id": {"type": "string", "description": "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns.", "nullable": true}, "return_line_items": {"type": "array", "items": {"type": "object", "description": "The line item being returned in an order.", "x-release-status": "BETA", "required": ["quantity"], "properties": {"uid": {"type": "string", "description": "A unique ID for this return line-item entry.", "maxLength": 60, "nullable": true}, "source_line_item_uid": {"type": "string", "description": "The `uid` of the line item in the original sale order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the line item.", "maxLength": 512, "nullable": true}, "quantity": {"type": "string", "description": "The quantity returned, formatted as a decimal number.\nFor example, `"3"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `"1.70000"`.", "minLength": 1, "maxLength": 12}, "quantity_unit": {"type": "object", "description": "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities.", "x-release-status": "PUBLIC", "properties": {"measurement_unit": {"type": "object", "description": "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.", "x-release-status": "PUBLIC", "properties": {"custom_unit": {"type": "object", "description": "The information needed to define a custom unit, provided by the seller.", "x-release-status": "PUBLIC", "required": ["name", "abbreviation"], "properties": {"name": {"type": "string", "description": "The name of the custom unit, for example "bushel"."}, "abbreviation": {"type": "string", "description": "The abbreviation of the custom unit, such as "bsh" (bushel). This appears\nin the cart for the Point of Sale app, and in reports."}}}, "area_unit": {"type": "string", "enum": ["IMPERIAL_ACRE", "IMPERIAL_SQUARE_INCH", "IMPERIAL_SQUARE_FOOT", "IMPERIAL_SQUARE_YARD", "IMPERIAL_SQUARE_MILE", "METRIC_SQUARE_CENTIMETER", "METRIC_SQUARE_METER", "METRIC_SQUARE_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_ACRE", "description": "The area is measured in acres."}, {"name": "IMPERIAL_SQUARE_INCH", "description": "The area is measured in square inches."}, {"name": "IMPERIAL_SQUARE_FOOT", "description": "The area is measured in square feet."}, {"name": "IMPERIAL_SQUARE_YARD", "description": "The area is measured in square yards."}, {"name": "IMPERIAL_SQUARE_MILE", "description": "The area is measured in square miles."}, {"name": "METRIC_SQUARE_CENTIMETER", "description": "The area is measured in square centimeters."}, {"name": "METRIC_SQUARE_METER", "description": "The area is measured in square meters."}, {"name": "METRIC_SQUARE_KILOMETER", "description": "The area is measured in square kilometers."}], "description": "Unit of area used to measure a quantity.", "x-release-status": "PUBLIC"}, "length_unit": {"type": "string", "enum": ["IMPERIAL_INCH", "IMPERIAL_FOOT", "IMPERIAL_YARD", "IMPERIAL_MILE", "METRIC_MILLIMETER", "METRIC_CENTIMETER", "METRIC_METER", "METRIC_KILOMETER"], "x-enum-elements": [{"name": "IMPERIAL_INCH", "description": "The length is measured in inches."}, {"name": "IMPERIAL_FOOT", "description": "The length is measured in feet."}, {"name": "IMPERIAL_YARD", "description": "The length is measured in yards."}, {"name": "IMPERIAL_MILE", "description": "The length is measured in miles."}, {"name": "METRIC_MILLIMETER", "description": "The length is measured in millimeters."}, {"name": "METRIC_CENTIMETER", "description": "The length is measured in centimeters."}, {"name": "METRIC_METER", "description": "The length is measured in meters."}, {"name": "METRIC_KILOMETER", "description": "The length is measured in kilometers."}], "description": "The unit of length used to measure a quantity.", "x-release-status": "PUBLIC"}, "volume_unit": {"type": "string", "enum": ["GENERIC_FLUID_OUNCE", "GENERIC_SHOT", "GENERIC_CUP", "GENERIC_PINT", "GENERIC_QUART", "GENERIC_GALLON", "IMPERIAL_CUBIC_INCH", "IMPERIAL_CUBIC_FOOT", "IMPERIAL_CUBIC_YARD", "METRIC_MILLILITER", "METRIC_LITER"], "x-enum-elements": [{"name": "GENERIC_FLUID_OUNCE", "description": "The volume is measured in ounces."}, {"name": "GENERIC_SHOT", "description": "The volume is measured in shots."}, {"name": "GENERIC_CUP", "description": "The volume is measured in cups."}, {"name": "GENERIC_PINT", "description": "The volume is measured in pints."}, {"name": "GENERIC_QUART", "description": "The volume is measured in quarts."}, {"name": "GENERIC_GALLON", "description": "The volume is measured in gallons."}, {"name": "IMPERIAL_CUBIC_INCH", "description": "The volume is measured in cubic inches."}, {"name": "IMPERIAL_CUBIC_FOOT", "description": "The volume is measured in cubic feet."}, {"name": "IMPERIAL_CUBIC_YARD", "description": "The volume is measured in cubic yards."}, {"name": "METRIC_MILLILITER", "description": "The volume is measured in metric milliliters."}, {"name": "METRIC_LITER", "description": "The volume is measured in metric liters."}], "description": "The unit of volume used to measure a quantity.", "x-release-status": "PUBLIC"}, "weight_unit": {"type": "string", "enum": ["IMPERIAL_WEIGHT_OUNCE", "IMPERIAL_POUND", "IMPERIAL_STONE", "METRIC_MILLIGRAM", "METRIC_GRAM", "METRIC_KILOGRAM"], "x-enum-elements": [{"name": "IMPERIAL_WEIGHT_OUNCE", "description": "The weight is measured in ounces."}, {"name": "IMPERIAL_POUND", "description": "The weight is measured in pounds."}, {"name": "IMPERIAL_STONE", "description": "The weight is measured in stones."}, {"name": "METRIC_MILLIGRAM", "description": "The weight is measured in milligrams."}, {"name": "METRIC_GRAM", "description": "The weight is measured in grams."}, {"name": "METRIC_KILOGRAM", "description": "The weight is measured in kilograms."}], "description": "Unit of weight used to measure a quantity.", "x-release-status": "PUBLIC"}, "generic_unit": {"type": "string", "enum": ["UNIT"], "x-enum-elements": [{"name": "UNIT", "description": "The generic unit."}], "x-release-status": "PUBLIC"}, "time_unit": {"type": "string", "enum": ["GENERIC_MILLISECOND", "GENERIC_SECOND", "GENERIC_MINUTE", "GENERIC_HOUR", "GENERIC_DAY"], "x-enum-elements": [{"name": "GENERIC_MILLISECOND", "description": "The time is measured in milliseconds."}, {"name": "GENERIC_SECOND", "description": "The time is measured in seconds."}, {"name": "GENERIC_MINUTE", "description": "The time is measured in minutes."}, {"name": "GENERIC_HOUR", "description": "The time is measured in hours."}, {"name": "GENERIC_DAY", "description": "The time is measured in days."}], "description": "Unit of time used to measure a quantity (a duration).", "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["TYPE_CUSTOM", "TYPE_AREA", "TYPE_LENGTH", "TYPE_VOLUME", "TYPE_WEIGHT", "TYPE_GENERIC"], "x-enum-elements": [{"name": "TYPE_CUSTOM", "description": "The unit details are contained in the custom_unit field."}, {"name": "TYPE_AREA", "description": "The unit details are contained in the area_unit field."}, {"name": "TYPE_LENGTH", "description": "The unit details are contained in the length_unit field."}, {"name": "TYPE_VOLUME", "description": "The unit details are contained in the volume_unit field."}, {"name": "TYPE_WEIGHT", "description": "The unit details are contained in the weight_unit field."}, {"name": "TYPE_GENERIC", "description": "The unit details are contained in the generic_unit field."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "PUBLIC"}}}, "precision": {"type": "integer", "description": "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.\n\nMin: 0. Max: 5.", "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing the\n[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).\n\nThis field is set when this is a catalog-backed measurement unit.", "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit.", "format": "int64", "nullable": true}}}, "note": {"type": "string", "description": "The note of the return line item.", "maxLength": 2000, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item references.", "format": "int64", "nullable": true}, "variation_name": {"type": "string", "description": "The name of the variation applied to this return line item.", "maxLength": 400, "nullable": true}, "item_type": {"type": "string", "enum": ["ITEM", "CUSTOM_AMOUNT", "GIFT_CARD"], "x-enum-elements": [{"name": "ITEM", "description": "Indicates that the line item is an itemized sale."}, {"name": "CUSTOM_AMOUNT", "description": "Indicates that the line item is a non-itemized sale."}, {"name": "GIFT_CARD", "description": "Indicates that the line item is a gift card sale. Gift cards sold through\nthe Orders API are sold in an unactivated state and can be activated through the\nGift Cards API using the line item `uid`."}], "description": "Represents the line item type.", "x-release-status": "BETA"}, "return_modifiers": {"type": "array", "items": {"type": "object", "description": "A line item modifier being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return modifier only within this order.", "maxLength": 60, "nullable": true}, "source_modifier_uid": {"type": "string", "description": "The modifier `uid` from the order\'s line item that contains the\noriginal sale of this line item modifier.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this line item modifier references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The name of the item modifier.", "maxLength": 255, "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "quantity": {"type": "string", "description": "The quantity of the line item modifier. The modifier quantity can be 0 or more.\nFor example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders\nthis item, the restaurant records the purchase by creating an `Order` object with a line item\nfor a burger. The line item includes a line item modifier: the name is cheese and the quantity\nis 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses\nthe extra cheese option, the modifier quantity increases to 2. If the buyer does not want\nany cheese, the modifier quantity is set to 0.", "nullable": true}}}, "description": "The [CatalogModifier](entity:CatalogModifier)s applied to this line item.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "applied_discounts": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items.", "x-release-status": "BETA", "required": ["discount_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied discount only within this order.", "maxLength": 60, "nullable": true}, "discount_uid": {"type": "string", "description": "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated.", "nullable": true}, "base_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "variation_total_price_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "gross_return_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_service_charges": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["service_charge_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied service charge only within this order.", "maxLength": 60, "nullable": true}, "service_charge_uid": {"type": "string", "description": "The `uid` of the service charge that the applied service charge represents. It must\nreference a service charge present in the `order.service_charges` field.\n\nThis field is immutable. To change which service charges apply to a line item,\ndelete and add a new `OrderLineItemAppliedServiceCharge`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnServiceCharge` entities applied to the return\nline item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that\nreferences the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line\nitem. On reads, the applied amount is populated.", "nullable": true}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "A collection of line items that are being returned.", "nullable": true}, "return_service_charges": {"type": "array", "items": {"type": "object", "description": "Represents the service charge applied to the original order.", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the return service charge only within this order.", "maxLength": 60, "x-release-status": "BETA", "nullable": true}, "source_service_charge_uid": {"type": "string", "description": "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the service charge.", "maxLength": 255, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this service charge references.", "format": "int64", "nullable": true}, "percentage": {"type": "string", "description": "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `"7.25"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "calculation_phase": {"type": "string", "enum": ["SUBTOTAL_PHASE", "TOTAL_PHASE", "APPORTIONED_PERCENTAGE_PHASE", "APPORTIONED_AMOUNT_PHASE"], "x-enum-elements": [{"name": "SUBTOTAL_PHASE", "description": "The service charge is applied after discounts, but before\ntaxes."}, {"name": "TOTAL_PHASE", "description": "The service charge is applied after all discounts and taxes\nare applied."}, {"name": "APPORTIONED_PERCENTAGE_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts, but before amount based apportioned service charges\nand any tax considerations."}, {"name": "APPORTIONED_AMOUNT_PHASE", "description": "The service charge is calculated as a compounding adjustment\nafter any discounts and percentage based apportioned service charges,\nbut before any tax considerations."}], "description": "Represents a phase in the process of calculating order totals.\nService charges are applied after the indicated phase.\n\n[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)", "x-release-status": "PUBLIC"}, "taxable": {"type": "boolean", "description": "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable.", "nullable": true}, "applied_taxes": {"type": "array", "items": {"type": "object", "description": "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items.", "x-release-status": "BETA", "required": ["tax_uid"], "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the applied tax only within this order.", "maxLength": 60, "nullable": true}, "tax_uid": {"type": "string", "description": "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`.", "minLength": 1, "maxLength": 60}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated.", "x-release-status": "BETA", "nullable": true}, "treatment_type": {"type": "string", "enum": ["LINE_ITEM_TREATMENT", "APPORTIONED_TREATMENT"], "x-enum-elements": [{"name": "LINE_ITEM_TREATMENT", "description": ""}, {"name": "APPORTIONED_TREATMENT", "description": ""}], "description": "Indicates whether the service charge will be treated as a value-holding line item or\napportioned toward a line item.", "x-release-status": "BETA"}, "scope": {"type": "string", "enum": ["OTHER_SERVICE_CHARGE_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_SERVICE_CHARGE_SCOPE", "description": "Used for reporting only.\nThe original transaction service charge scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The service charge should be applied to only line items specified by\n`OrderLineItemAppliedServiceCharge` reference records."}, {"name": "ORDER", "description": "The service charge should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level apportioned\nservice charge.", "x-release-status": "BETA"}}}, "description": "A collection of service charges that are being returned.", "nullable": true}, "return_taxes": {"type": "array", "items": {"type": "object", "description": "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned tax only within this order.", "maxLength": 60, "nullable": true}, "source_tax_uid": {"type": "string", "description": "The tax `uid` from the order that contains the original tax charge.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogTax](entity:CatalogTax).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this tax references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The tax\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"], "x-enum-elements": [{"name": "UNKNOWN_TAX", "description": "Used for reporting only.\nThe original transaction tax type is currently not supported by the API."}, {"name": "ADDITIVE", "description": "The tax is an additive tax. The tax amount is added on top of the price.\nFor example, an item with a cost of 1.00 USD and a 10% additive tax has a total\ncost to the buyer of 1.10 USD."}, {"name": "INCLUSIVE", "description": "The tax is an inclusive tax. Inclusive taxes are already included\nin the line item price or order total. For example, an item with a cost of\n1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD\n(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to\nthe buyer."}], "description": "Indicates how the tax is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `"7.25"` corresponds to a percentage of 7.25%.", "maxLength": 10, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_TAX_SCOPE", "description": "Used for reporting only.\nThe original transaction tax scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The tax should be applied only to line items specified by\nthe `OrderLineItemAppliedTax` reference records."}, {"name": "ORDER", "description": "The tax should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level tax.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder.", "readOnly": true}, "return_discounts": {"type": "array", "items": {"type": "object", "description": "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item\u2019s contribution to the\norder subtotal.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the returned discount only within this order.", "maxLength": 60, "nullable": true}, "source_discount_uid": {"type": "string", "description": "The discount `uid` from the order that contains the original application of this discount.", "maxLength": 60, "nullable": true}, "catalog_object_id": {"type": "string", "description": "The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).", "maxLength": 192, "nullable": true}, "catalog_version": {"type": "integer", "description": "The version of the catalog object that this discount references.", "format": "int64", "nullable": true}, "name": {"type": "string", "description": "The discount\'s name.", "maxLength": 255, "nullable": true}, "type": {"type": "string", "enum": ["UNKNOWN_DISCOUNT", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"], "x-enum-elements": [{"name": "UNKNOWN_DISCOUNT", "description": "Used for reporting only.\nThe original transaction discount type is currently not supported by the API."}, {"name": "FIXED_PERCENTAGE", "description": "Apply the discount as a fixed percentage (such as 5%) off the item price."}, {"name": "FIXED_AMOUNT", "description": "Apply the discount as a fixed monetary value (such as $1.00) off the item price."}, {"name": "VARIABLE_PERCENTAGE", "description": "Apply the discount as a variable percentage based on the item\nprice.\n\nThe specific discount percentage of a `VARIABLE_PERCENTAGE` discount\nis assigned at the time of the purchase."}, {"name": "VARIABLE_AMOUNT", "description": "Apply the discount as a variable amount based on the item price.\n\nThe specific discount amount of a `VARIABLE_AMOUNT` discount\nis assigned at the time of the purchase."}], "description": "Indicates how the discount is applied to the associated line item or order.", "x-release-status": "PUBLIC"}, "percentage": {"type": "string", "description": "The percentage of the tax, as a string representation of a decimal number.\nA value of `"7.25"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts.", "maxLength": 10, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "scope": {"type": "string", "enum": ["OTHER_DISCOUNT_SCOPE", "LINE_ITEM", "ORDER"], "x-enum-elements": [{"name": "OTHER_DISCOUNT_SCOPE", "description": "Used for reporting only.\nThe original transaction discount scope is currently not supported by the API."}, {"name": "LINE_ITEM", "description": "The discount should be applied to only line items specified by\n`OrderLineItemAppliedDiscount` reference records."}, {"name": "ORDER", "description": "The discount should be applied to the entire order."}], "description": "Indicates whether this is a line-item or order-level discount.", "x-release-status": "PUBLIC"}}}, "description": "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order.", "readOnly": true}, "return_tips": {"type": "array", "items": {"type": "object", "description": "A tip being returned.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the tip only within this order.", "maxLength": 60, "nullable": true}, "applied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "source_tender_uid": {"type": "string", "description": "The tender `uid` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}, "source_tender_id": {"type": "string", "description": "The tender `id` from the order that contains the original application of this tip.", "maxLength": 192, "nullable": true}}}, "description": "A collection of references to tips being returned for an order.", "nullable": true}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}}, "description": "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced.", "readOnly": true, "x-release-status": "BETA"}, "return_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "net_amounts": {"type": "object", "description": "A collection of various money amounts.", "x-release-status": "BETA", "properties": {"total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "rounding_adjustment": {"type": "object", "description": "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency.", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "A unique ID that identifies the rounding adjustment only within this order.", "maxLength": 60, "nullable": true}, "name": {"type": "string", "description": "The name of the rounding adjustment from the original sale order.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "tenders": {"type": "array", "items": {"type": "object", "description": "Represents a tender (i.e., a method of payment) used in a Square transaction.", "x-release-status": "PUBLIC", "required": ["type"], "properties": {"id": {"type": "string", "description": "The tender\'s unique ID. It is the associated payment ID.", "maxLength": 192}, "location_id": {"type": "string", "description": "The ID of the transaction\'s associated location.", "maxLength": 50, "nullable": true}, "transaction_id": {"type": "string", "description": "The ID of the tender\'s associated transaction.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the tender was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "note": {"type": "string", "description": "An optional note associated with the tender at the time of payment.", "maxLength": 500, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "customer_id": {"type": "string", "description": "If the tender is associated with a customer or represents a customer\'s card on file,\nthis is the ID of the associated customer.", "maxLength": 191, "nullable": true}, "type": {"type": "string", "enum": ["CARD", "CASH", "THIRD_PARTY_CARD", "SQUARE_GIFT_CARD", "NO_SALE", "BANK_ACCOUNT", "WALLET", "BUY_NOW_PAY_LATER", "SQUARE_ACCOUNT", "OTHER"], "x-enum-elements": [{"name": "CARD", "description": "A credit card."}, {"name": "CASH", "description": "Cash."}, {"name": "THIRD_PARTY_CARD", "description": "A credit card processed with a card processor other than Square.\n\nThis value applies only to merchants in countries where Square does not\nyet provide card processing."}, {"name": "SQUARE_GIFT_CARD", "description": "A Square gift card."}, {"name": "NO_SALE", "description": "This tender represents the register being opened for a "no sale" event."}, {"name": "BANK_ACCOUNT", "description": "A bank account payment."}, {"name": "WALLET", "description": "A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,\nAu Pay, D Barai, Merpay, Wechat Pay, Alipay.\n\nNote: Some "digital wallets", including Google Pay and Apple Pay, facilitate\ncard payments.  Those payments have the `CARD` type."}, {"name": "BUY_NOW_PAY_LATER", "description": "A Buy Now Pay Later payment."}, {"name": "SQUARE_ACCOUNT", "description": "A Square House Account payment."}, {"name": "OTHER", "description": "A form of tender that does not match any other value."}], "description": "Indicates a tender\'s type.", "x-release-status": "PUBLIC"}, "card_details": {"type": "object", "description": "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The card transaction has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The card transaction was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The card transaction was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The card transaction failed."}], "description": "Indicates the card transaction\'s current status.", "x-release-status": "PUBLIC"}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}, "entry_method": {"type": "string", "enum": ["SWIPED", "KEYED", "EMV", "ON_FILE", "CONTACTLESS"], "x-enum-elements": [{"name": "SWIPED", "description": "The card was swiped through a Square reader or Square stand."}, {"name": "KEYED", "description": "The card information was keyed manually into Square Point of Sale or a\nSquare-hosted web form."}, {"name": "EMV", "description": "The card was processed via EMV with a Square reader."}, {"name": "ON_FILE", "description": "The buyer\'s card details were already on file with Square."}, {"name": "CONTACTLESS", "description": "The card was processed via a contactless (i.e., NFC) transaction\nwith a Square reader."}], "description": "Indicates the method used to enter the card\'s details.", "x-release-status": "PUBLIC"}}}, "cash_details": {"type": "object", "description": "Represents the details of a tender with `type` `CASH`.", "x-release-status": "PUBLIC", "properties": {"buyer_tendered_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "bank_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `BANK_ACCOUNT`.\n\nSee [BankAccountPaymentDetails](entity:BankAccountPaymentDetails)\nfor more exposed details of a bank account payment.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["PENDING", "COMPLETED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The bank account payment is in progress."}, {"name": "COMPLETED", "description": "The bank account payment has been completed."}, {"name": "FAILED", "description": "The bank account payment failed."}], "description": "Indicates the bank account payment\'s current status.", "x-release-status": "PUBLIC"}}}, "buy_now_pay_later_details": {"type": "object", "description": "Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.", "x-release-status": "PUBLIC", "properties": {"buy_now_pay_later_brand": {"type": "string", "enum": ["OTHER_BRAND", "AFTERPAY"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "AFTERPAY", "description": ""}], "x-release-status": "PUBLIC"}, "status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The buy now pay later payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The buy now pay later payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The buy now pay later payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The buy now pay later payment failed."}], "x-release-status": "PUBLIC"}}}, "square_account_details": {"type": "object", "description": "Represents the details of a tender with `type` `SQUARE_ACCOUNT`.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "enum": ["AUTHORIZED", "CAPTURED", "VOIDED", "FAILED"], "x-enum-elements": [{"name": "AUTHORIZED", "description": "The Square Account payment has been authorized but not yet captured."}, {"name": "CAPTURED", "description": "The Square Account payment was authorized and subsequently captured (i.e., completed)."}, {"name": "VOIDED", "description": "The Square Account payment was authorized and subsequently voided (i.e., canceled)."}, {"name": "FAILED", "description": "The Square Account payment failed."}], "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}, "payment_id": {"type": "string", "description": "The ID of the [Payment](entity:Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API.", "maxLength": 192, "nullable": true}}}, "description": "The tenders that were used to pay for the order.", "readOnly": true, "x-release-status": "BETA"}, "refunds": {"type": "array", "items": {"type": "object", "description": "Represents a refund processed for a Square transaction.", "x-release-status": "PUBLIC", "required": ["id", "location_id", "reason", "amount_money", "status"], "properties": {"id": {"type": "string", "description": "The refund\'s unique ID.", "maxLength": 255}, "location_id": {"type": "string", "description": "The ID of the refund\'s associated location.", "maxLength": 50}, "transaction_id": {"type": "string", "description": "The ID of the transaction that the refunded tender is part of.", "maxLength": 192, "nullable": true}, "tender_id": {"type": "string", "description": "The ID of the refunded tender.", "maxLength": 192, "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the refund was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "reason": {"type": "string", "description": "The reason for the refund being issued.", "maxLength": 192}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "enum": ["PENDING", "APPROVED", "REJECTED", "FAILED"], "x-enum-elements": [{"name": "PENDING", "description": "The refund is pending."}, {"name": "APPROVED", "description": "The refund has been approved by Square."}, {"name": "REJECTED", "description": "The refund has been rejected by Square."}, {"name": "FAILED", "description": "The refund failed."}], "description": "Indicates a refund\'s current status.", "x-release-status": "PUBLIC"}, "processing_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "additional_recipients": {"type": "array", "items": {"type": "object", "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.", "x-release-status": "DEPRECATED", "required": ["location_id", "amount_money"], "properties": {"location_id": {"type": "string", "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.", "minLength": 1, "maxLength": 50}, "description": {"type": "string", "description": "The description of the additional recipient.", "maxLength": 100, "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "receivable_id": {"type": "string", "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.", "maxLength": 192, "nullable": true}}}, "description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.", "x-release-status": "DEPRECATED", "nullable": true}}}, "description": "The refunds that are part of this order.", "readOnly": true, "x-release-status": "BETA"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}, "description": "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a \':\' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see  [Metadata](https://developer.squareup.com/docs/build-basics/metadata).", "x-release-status": "BETA", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").", "readOnly": true}, "closed_at": {"type": "string", "description": "The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z").", "readOnly": true}, "state": {"type": "string", "enum": ["OPEN", "COMPLETED", "CANCELED", "DRAFT"], "x-enum-elements": [{"name": "OPEN", "description": "Indicates that the order is open. Open orders can be updated."}, {"name": "COMPLETED", "description": "Indicates that the order is completed. Completed orders are fully paid. This is a terminal state."}, {"name": "CANCELED", "description": "Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state."}, {"name": "DRAFT", "description": "Indicates that the order is in a draft state. Draft orders can be updated,\nbut cannot be paid or fulfilled.\nFor more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders)."}], "description": "The state of the order.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders).", "x-release-status": "BETA"}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tax_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_discount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_service_charge_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "ticket_name": {"type": "string", "description": "A short-term identifier for the order (such as a customer first name,\ntable number, or auto-generated order number that resets daily).", "maxLength": 30, "x-release-status": "BETA", "nullable": true}, "pricing_options": {"type": "object", "description": "Pricing options for an order. The options affect how the order\'s price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](entity:CatalogPricingRule).", "x-release-status": "PUBLIC", "properties": {"auto_apply_discounts": {"type": "boolean", "description": "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order.", "nullable": true}, "auto_apply_taxes": {"type": "boolean", "description": "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met.", "x-release-status": "BETA", "nullable": true}}}, "rewards": {"type": "array", "items": {"type": "object", "description": "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API.", "x-release-status": "BETA", "required": ["id", "reward_tier_id"], "properties": {"id": {"type": "string", "description": "The identifier of the reward.", "minLength": 1}, "reward_tier_id": {"type": "string", "description": "The identifier of the reward tier corresponding to this reward.", "minLength": 1}}}, "description": "A set-like list of Rewards that have been added to the Order.", "readOnly": true, "x-release-status": "BETA"}, "net_amount_due_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "fields_to_clear": {"type": "array", "items": {"type": "string"}, "description": "The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)\nfields to clear. For example, `line_items[uid].note`.\nFor more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields).", "nullable": true}, "idempotency_key": {"type": "string", "description": "A value you specify that uniquely identifies this update request.\n\nIf you are unsure whether a particular update was applied to an order successfully,\nyou can reattempt it with the same idempotency key without\nworrying about creating duplicate updates to the order.\nThe latest order version is returned.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "maxLength": 192, "nullable": true}}, "example": {"fields_to_clear": ["discounts"], "idempotency_key": "UNIQUE_STRING", "order": {"line_items": [{"base_price_money": {"amount": 200, "currency": "USD"}, "name": "COOKIE", "quantity": "2", "uid": "cookie_uid"}], "version": 1}}}',  # noqa: E501
    "UPDATEORDERCUSTOMATTRIBUTE": '{"type": "object", "description": "Represents an upsert request for an order custom attribute.", "x-release-status": "BETA", "required": ["custom_attribute"], "properties": {"custom_attribute": {"type": "object", "description": "A custom attribute value. Each custom attribute value has a corresponding\n`CustomAttributeDefinition` object.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "value": {"description": "The value assigned to the custom attribute. It is validated against the custom\nattribute definition\'s schema on write operations. For more information about custom\nattribute values,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).", "nullable": true}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.\nWhen updating an existing custom attribute value, you can provide this field\nand specify the current version of the custom attribute to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "definition": {"type": "object", "description": "Represents a definition for custom attribute values. A custom attribute definition\nspecifies the key, visibility, schema, and other properties for a custom attribute.", "x-release-status": "PUBLIC", "properties": {"key": {"type": "string", "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.", "minLength": 1, "pattern": "^([a-zA-Z0-9\\._-]+:)?[a-zA-Z0-9\\._-]{1,60}$", "nullable": true}, "schema": {"type": "object", "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.", "nullable": true}, "name": {"type": "string", "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "description": {"type": "string", "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.", "maxLength": 255, "nullable": true}, "visibility": {"type": "string", "enum": ["VISIBILITY_HIDDEN", "VISIBILITY_READ_ONLY", "VISIBILITY_READ_WRITE_VALUES"], "x-enum-elements": [{"name": "VISIBILITY_HIDDEN", "description": "The custom attribute definition and values are hidden from the seller (except on export\nof all seller data) and other developers."}, {"name": "VISIBILITY_READ_ONLY", "description": "The seller and other developers can read the custom attribute definition and values\non resources."}, {"name": "VISIBILITY_READ_WRITE_VALUES", "description": "The seller and other developers can read the custom attribute definition,\nand can read and write values on resources. A custom attribute definition\ncan only be edited or deleted by the application that created it."}], "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.", "x-release-status": "PUBLIC"}, "version": {"type": "integer", "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.", "readOnly": true}}}, "updated_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created or was most recently\nupdated, in RFC 3339 format.", "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp that indicates when the custom attribute was created, in RFC 3339 format.", "readOnly": true}}}, "idempotency_key": {"type": "string", "description": "A unique identifier for this request, used to ensure idempotency. \nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "minLength": 1, "maxLength": 45, "nullable": true}}, "example": {"custom_attribute": {"key": "table-number", "value": "42", "version": 1}}}',  # noqa: E501
    "CREATEPAYMENT": '{"type": "object", "description": "Describes a request to create a payment using\n[CreatePayment](api-endpoint:Payments-CreatePayment).", "x-release-status": "PUBLIC", "required": ["source_id", "idempotency_key"], "properties": {"source_id": {"type": "string", "description": "The ID for the source of funds for this payment.\nThis could be a payment token generated by the Web Payments SDK for any of its\n[supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods),\nincluding cards, bank transfers, Afterpay or Cash App Pay. If recording a payment\nthat the seller received outside of Square, specify either "CASH" or "EXTERNAL".\nFor more information, see\n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).", "minLength": 1}, "idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreatePayment` request. Keys can be any valid string\nbut must be unique for every `CreatePayment` request.\n\nNote: The number of allowed characters might be less than the stated maximum, if multi-byte\ncharacters are used.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", "minLength": 1, "maxLength": 45}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "delay_duration": {"type": "string", "description": "The duration of time after the payment\'s creation when Square automatically\neither completes or cancels the payment depending on the `delay_action` field value.\nFor more information, see\n[Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).\n\nThis parameter should be specified as a time duration, in RFC 3339 format.\n\nNote: This feature is only supported for card payments. This parameter can only be set for a delayed\ncapture payment (`autocomplete=false`).\n\nDefault:\n\n- Card-present payments: "PT36H" (36 hours) from the creation time.\n- Card-not-present payments: "P7D" (7 days) from the creation time."}, "delay_action": {"type": "string", "description": "The action to be applied to the payment when the `delay_duration` has elapsed. The action must be\nCANCEL or COMPLETE. For more information, see\n[Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).\n\nDefault: CANCEL"}, "autocomplete": {"type": "boolean", "description": "If set to `true`, this payment will be completed when possible. If\nset to `false`, this payment is held in an approved state until either\nexplicitly completed (captured) or canceled (voided). For more information, see\n[Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).\n\nDefault: true"}, "order_id": {"type": "string", "description": "Associates a previously created order with this payment."}, "customer_id": {"type": "string", "description": "The [Customer](entity:Customer) ID of the customer associated with the payment.\n\nThis is required if the `source_id` refers to a card on file created using the Cards API."}, "location_id": {"type": "string", "description": "The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is\nused."}, "team_member_id": {"type": "string", "description": "An optional [TeamMember](entity:TeamMember) ID to associate with\nthis payment."}, "reference_id": {"type": "string", "description": "A user-defined ID to associate with the payment.\n\nYou can use this field to associate the payment to an entity in an external system\n(for example, you might specify an order ID that is generated by a third-party shopping cart).", "maxLength": 40}, "verification_token": {"type": "string", "description": "An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).\nVerification tokens encapsulate customer device information and 3-D Secure\nchallenge results to indicate that Square has verified the buyer identity.\n\nFor more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview)."}, "accept_partial_authorization": {"type": "boolean", "description": "If set to `true` and charging a Square Gift Card, a payment might be returned with\n`amount_money` equal to less than what was requested. For example, a request for $20 when charging\na Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose\nto prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card\npayment. This field cannot be `true` when `autocomplete = true`.\n\nFor more information, see\n[Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).\n\nDefault: false"}, "buyer_email_address": {"type": "string", "description": "The buyer\'s email address.", "maxLength": 255}, "buyer_phone_number": {"type": "string", "description": "The buyer\'s phone number.\nMust follow the following format:\n1. A leading + symbol (followed by a country code)\n2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`.\nAlphabetical characters aren\'t allowed.\n3. The phone number must contain between 9 and 16 digits."}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "shipping_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "note": {"type": "string", "description": "An optional note to be entered by the developer when creating a payment.", "maxLength": 500}, "statement_description_identifier": {"type": "string", "description": "Optional additional payment information to include on the customer\'s card statement\nas part of the statement description. This can be, for example, an invoice number, ticket number,\nor short description that uniquely identifies the purchase.\n\nNote that the `statement_description_identifier` might get truncated on the statement description\nto fit the required information including the Square identifier (SQ *) and name of the\nseller taking the payment.", "maxLength": 20}, "cash_details": {"type": "object", "description": "Stores details about a cash payment. Contains only non-confidential information. For more information, see \n[Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments).", "x-release-status": "PUBLIC", "required": ["buyer_supplied_money"], "properties": {"buyer_supplied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "external_details": {"type": "object", "description": "Stores details about an external payment. Contains only non-confidential information.\nFor more information, see \n[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).", "x-release-status": "PUBLIC", "required": ["type", "source"], "properties": {"type": {"type": "string", "description": "The type of external payment the seller received. It can be one of the following:\n- CHECK - Paid using a physical check.\n- BANK_TRANSFER - Paid using external bank transfer.\n- OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card.\n- CRYPTO - Paid using a crypto currency.\n- SQUARE_CASH - Paid using Square Cash App.\n- SOCIAL - Paid using peer-to-peer payment applications.\n- EXTERNAL - A third-party application gathered this payment outside of Square.\n- EMONEY - Paid using an E-money provider.\n- CARD - A credit or debit card that Square does not support.\n- STORED_BALANCE - Use for house accounts, store credit, and so forth.\n- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals\n- OTHER - A type not listed here.", "maxLength": 50}, "source": {"type": "string", "description": "A description of the external payment source. For example, \n"Food Delivery Service".", "maxLength": 255}, "source_id": {"type": "string", "description": "An ID to associate the payment to its originating source.", "maxLength": 255, "nullable": true}, "source_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "customer_details": {"type": "object", "description": "Details about the customer making the payment.", "x-release-status": "PUBLIC", "properties": {"customer_initiated": {"type": "boolean", "description": "Indicates whether the customer initiated the payment.", "nullable": true}, "seller_keyed_in": {"type": "boolean", "description": "Indicates that the seller keyed in payment details on behalf of the customer.\nThis is used to flag a payment as Mail Order / Telephone Order (MOTO).", "nullable": true}}}, "offline_payment_details": {"type": "object", "description": "Details specific to offline payments.", "x-release-status": "DEPRECATED", "properties": {"client_created_at": {"type": "string", "description": "The client-side timestamp of when the offline payment was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}}}}, "example": {"amount_money": {"amount": 1000, "currency": "USD"}, "app_fee_money": {"amount": 10, "currency": "USD"}, "autocomplete": true, "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8", "idempotency_key": "7b0f3ec5-086a-4871-8f13-3c81b3875218", "location_id": "L88917AVBK2S5", "note": "Brief description", "reference_id": "123456", "source_id": "ccof:GaJGNaZa8x4OgDJn4GB"}}',  # noqa: E501
    "UPDATEPAYMENTSTATUS": '{"type": "object", "description": "Describes a request to update a payment using\n[UpdatePayment](api-endpoint:Payments-UpdatePayment).", "x-release-status": "PUBLIC", "required": ["idempotency_key"], "properties": {"payment": {"type": "object", "description": "Represents a payment processed by the Square API.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "A unique ID for the payment.", "maxLength": 192, "readOnly": true}, "created_at": {"type": "string", "description": "The timestamp of when the payment was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp of when the payment was last updated, in RFC 3339 format.", "maxLength": 32, "readOnly": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "total_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "approved_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "processing_fee": {"type": "array", "items": {"type": "object", "description": "Represents the Square processing fee.", "x-release-status": "PUBLIC", "properties": {"effective_at": {"type": "string", "description": "The timestamp of when the fee takes effect, in RFC 3339 format.", "nullable": true}, "type": {"type": "string", "description": "The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`.", "nullable": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "description": "The processing fees and fee adjustments assessed by Square for this payment.", "readOnly": true}, "refunded_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "status": {"type": "string", "description": "Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.", "maxLength": 50, "readOnly": true}, "delay_duration": {"type": "string", "description": "The duration of time after the payment\'s creation when Square automatically applies the\n`delay_action` to the payment. This automatic `delay_action` applies only to payments that\ndo not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration`\ntime period.\n\nThis field is specified as a time duration, in RFC 3339 format.\n\nNotes:\nThis feature is only supported for card payments.\n\nDefault:\n\n- Card-present payments: "PT36H" (36 hours) from the creation time.\n- Card-not-present payments: "P7D" (7 days) from the creation time.", "readOnly": true}, "delay_action": {"type": "string", "description": "The action to be applied to the payment when the `delay_duration` has elapsed.\n\nCurrent values include `CANCEL` and `COMPLETE`.", "nullable": true}, "delayed_until": {"type": "string", "description": "The read-only timestamp of when the `delay_action` is automatically applied,\nin RFC 3339 format.\n\nNote that this field is calculated by summing the payment\'s `delay_duration` and `created_at`\nfields. The `created_at` field is generated by Square and might not exactly match the\ntime on your local machine.", "readOnly": true}, "source_type": {"type": "string", "description": "The source type for this payment.\n\nCurrent values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`,\n`CASH` and `EXTERNAL`. For information about these payment source types,\nsee [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).", "maxLength": 50, "readOnly": true}, "card_details": {"type": "object", "description": "Reflects the current status of a card payment. Contains only non-confidential information.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "description": "The card payment\'s current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or\nFAILED.", "maxLength": 50, "readOnly": true}, "card": {"type": "object", "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "Unique ID for this card. Generated by Square.", "maxLength": 64, "readOnly": true}, "card_brand": {"type": "string", "enum": ["OTHER_BRAND", "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD", "SQUARE_CAPITAL_CARD", "INTERAC", "EFTPOS", "FELICA", "EBT"], "x-enum-elements": [{"name": "OTHER_BRAND", "description": ""}, {"name": "VISA", "description": ""}, {"name": "MASTERCARD", "description": ""}, {"name": "AMERICAN_EXPRESS", "description": ""}, {"name": "DISCOVER", "description": ""}, {"name": "DISCOVER_DINERS", "description": ""}, {"name": "JCB", "description": ""}, {"name": "CHINA_UNIONPAY", "description": ""}, {"name": "SQUARE_GIFT_CARD", "description": ""}, {"name": "SQUARE_CAPITAL_CARD", "description": ""}, {"name": "INTERAC", "description": ""}, {"name": "EFTPOS", "description": ""}, {"name": "FELICA", "description": ""}, {"name": "EBT", "description": ""}], "description": "Indicates a card\'s brand, such as `VISA` or `MASTERCARD`.", "x-release-status": "PUBLIC"}, "last_4": {"type": "string", "description": "The last 4 digits of the card number.", "maxLength": 4, "readOnly": true}, "exp_month": {"type": "integer", "description": "The expiration month of the associated card as an integer between 1 and 12.", "format": "int64", "nullable": true}, "exp_year": {"type": "integer", "description": "The four-digit year of the card\'s expiration date.", "format": "int64", "nullable": true}, "cardholder_name": {"type": "string", "description": "The name of the cardholder.", "maxLength": 96, "nullable": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "fingerprint": {"type": "string", "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.", "maxLength": 255, "readOnly": true}, "customer_id": {"type": "string", "description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the merchant associated with the card.", "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.", "maxLength": 128, "nullable": true}, "enabled": {"type": "boolean", "description": "Indicates whether or not a card can be used for payments.", "readOnly": true}, "card_type": {"type": "string", "enum": ["UNKNOWN_CARD_TYPE", "CREDIT", "DEBIT"], "x-enum-elements": [{"name": "UNKNOWN_CARD_TYPE", "description": ""}, {"name": "CREDIT", "description": ""}, {"name": "DEBIT", "description": ""}], "description": "Indicates a card\'s type, such as `CREDIT` or `DEBIT`.", "x-release-status": "PUBLIC"}, "prepaid_type": {"type": "string", "enum": ["UNKNOWN_PREPAID_TYPE", "NOT_PREPAID", "PREPAID"], "x-enum-elements": [{"name": "UNKNOWN_PREPAID_TYPE", "description": ""}, {"name": "NOT_PREPAID", "description": ""}, {"name": "PREPAID", "description": ""}], "description": "Indicates a card\'s prepaid type, such as `NOT_PREPAID` or `PREPAID`.", "x-release-status": "PUBLIC"}, "bin": {"type": "string", "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.", "maxLength": 6, "readOnly": true}, "version": {"type": "integer", "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.", "format": "int64"}, "card_co_brand": {"type": "string", "enum": ["UNKNOWN", "AFTERPAY", "CLEARPAY"], "x-enum-elements": [{"name": "UNKNOWN", "description": ""}, {"name": "AFTERPAY", "description": ""}, {"name": "CLEARPAY", "description": ""}], "description": "Indicates the brand for a co-branded card.", "x-release-status": "PUBLIC"}, "issuer_alert": {"type": "string", "enum": ["ISSUER_ALERT_CARD_CLOSED"], "x-enum-elements": [{"name": "ISSUER_ALERT_CARD_CLOSED", "description": "The underlying account of the card was closed, which is a strong signal that future\ncharges to the card are likely to fail."}], "description": "Indicates the type of issuer alert for a [card on file](entity:Card).", "x-release-status": "BETA"}, "issuer_alert_at": {"type": "string", "description": "The timestamp of when the current issuer alert was received and processed, in\nRFC 3339 format.\n\nThis field is present only if there\'s an active issuer alert.", "readOnly": true, "x-release-status": "BETA"}, "hsa_fsa": {"type": "boolean", "description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN.", "readOnly": true, "x-release-status": "BETA"}}}, "entry_method": {"type": "string", "description": "The method used to enter the card\'s details for the payment. The method can be\n`KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.", "maxLength": 50, "readOnly": true}, "cvv_status": {"type": "string", "description": "The status code returned from the Card Verification Value (CVV) check. The code can be\n`CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`.", "maxLength": 50, "readOnly": true}, "avs_status": {"type": "string", "description": "The status code returned from the Address Verification System (AVS) check. The code can be\n`AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`.", "maxLength": 50, "readOnly": true}, "auth_result_code": {"type": "string", "description": "The status code returned by the card issuer that describes the payment\'s\nauthorization status.", "maxLength": 10, "readOnly": true}, "application_identifier": {"type": "string", "description": "For EMV payments, the application ID identifies the EMV application used for the payment.", "maxLength": 32, "readOnly": true}, "application_name": {"type": "string", "description": "For EMV payments, the human-readable name of the EMV application used for the payment.", "maxLength": 16, "readOnly": true}, "application_cryptogram": {"type": "string", "description": "For EMV payments, the cryptogram generated for the payment.", "maxLength": 16, "readOnly": true}, "verification_method": {"type": "string", "description": "For EMV payments, the method used to verify the cardholder\'s identity. The method can be\n`PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`.", "maxLength": 50, "readOnly": true}, "verification_results": {"type": "string", "description": "For EMV payments, the results of the cardholder verification. The result can be\n`SUCCESS`, `FAILURE`, or `UNKNOWN`.", "maxLength": 50, "readOnly": true}, "statement_description": {"type": "string", "description": "The statement description sent to the card networks.\n\nNote: The actual statement description varies and is likely to be truncated and appended with\nadditional information on a per issuer basis.", "maxLength": 50, "readOnly": true}, "device_details": {"type": "object", "description": "Details about the device that took the payment.", "x-release-status": "PUBLIC", "properties": {"device_id": {"type": "string", "description": "The Square-issued ID of the device.", "maxLength": 255, "nullable": true}, "device_installation_id": {"type": "string", "description": "The Square-issued installation ID for the device.", "maxLength": 255, "nullable": true}, "device_name": {"type": "string", "description": "The name of the device set by the seller.", "maxLength": 255, "nullable": true}}}, "card_payment_timeline": {"type": "object", "description": "The timeline for card payments.", "x-release-status": "PUBLIC", "properties": {"authorized_at": {"type": "string", "description": "The timestamp when the payment was authorized, in RFC 3339 format.", "nullable": true}, "captured_at": {"type": "string", "description": "The timestamp when the payment was captured, in RFC 3339 format.", "nullable": true}, "voided_at": {"type": "string", "description": "The timestamp when the payment was voided, in RFC 3339 format.", "nullable": true}}}, "refund_requires_card_presence": {"type": "boolean", "description": "Whether the card must be physically present for the payment to\nbe refunded.  If set to `true`, the card must be present.", "readOnly": true, "x-release-status": "BETA"}, "errors": {"type": "array", "items": {"type": "object", "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.", "x-release-status": "PUBLIC", "required": ["category", "code"], "properties": {"category": {"type": "string", "enum": ["API_ERROR", "AUTHENTICATION_ERROR", "INVALID_REQUEST_ERROR", "RATE_LIMIT_ERROR", "PAYMENT_METHOD_ERROR", "REFUND_ERROR", "MERCHANT_SUBSCRIPTION_ERROR", "EXTERNAL_VENDOR_ERROR"], "x-enum-elements": [{"name": "API_ERROR", "description": "An error occurred with the Connect API itself."}, {"name": "AUTHENTICATION_ERROR", "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header."}, {"name": "INVALID_REQUEST_ERROR", "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value."}, {"name": "RATE_LIMIT_ERROR", "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule."}, {"name": "PAYMENT_METHOD_ERROR", "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card\'s CVV\nor expiration date)."}, {"name": "REFUND_ERROR", "description": "An error occurred while attempting to process a refund."}, {"name": "MERCHANT_SUBSCRIPTION_ERROR", "description": "An error occurred when checking a merchant subscription status"}, {"name": "EXTERNAL_VENDOR_ERROR", "description": "An error that is returned from an external vendor\'s API"}], "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.", "x-release-status": "PUBLIC"}, "code": {"type": "string", "enum": ["INTERNAL_SERVER_ERROR", "UNAUTHORIZED", "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_REVOKED", "CLIENT_DISABLED", "FORBIDDEN", "INSUFFICIENT_SCOPES", "APPLICATION_DISABLED", "V1_APPLICATION", "V1_ACCESS_TOKEN", "CARD_PROCESSING_NOT_ENABLED", "MERCHANT_SUBSCRIPTION_NOT_FOUND", "BAD_REQUEST", "MISSING_REQUIRED_PARAMETER", "INCORRECT_TYPE", "INVALID_TIME", "INVALID_TIME_RANGE", "INVALID_VALUE", "INVALID_CURSOR", "UNKNOWN_QUERY_PARAMETER", "CONFLICTING_PARAMETERS", "EXPECTED_JSON_BODY", "INVALID_SORT_ORDER", "VALUE_REGEX_MISMATCH", "VALUE_TOO_SHORT", "VALUE_TOO_LONG", "VALUE_TOO_LOW", "VALUE_TOO_HIGH", "VALUE_EMPTY", "ARRAY_LENGTH_TOO_LONG", "ARRAY_LENGTH_TOO_SHORT", "ARRAY_EMPTY", "EXPECTED_BOOLEAN", "EXPECTED_INTEGER", "EXPECTED_FLOAT", "EXPECTED_STRING", "EXPECTED_OBJECT", "EXPECTED_ARRAY", "EXPECTED_MAP", "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "INVALID_ARRAY_VALUE", "INVALID_ENUM_VALUE", "INVALID_CONTENT_TYPE", "INVALID_FORM_VALUE", "CUSTOMER_NOT_FOUND", "ONE_INSTRUMENT_EXPECTED", "NO_FIELDS_SET", "TOO_MANY_MAP_ENTRIES", "MAP_KEY_LENGTH_TOO_SHORT", "MAP_KEY_LENGTH_TOO_LONG", "CUSTOMER_MISSING_NAME", "CUSTOMER_MISSING_EMAIL", "INVALID_PAUSE_LENGTH", "INVALID_DATE", "UNSUPPORTED_COUNTRY", "UNSUPPORTED_CURRENCY", "APPLE_TTP_PIN_TOKEN", "CARD_EXPIRED", "INVALID_EXPIRATION", "INVALID_EXPIRATION_YEAR", "INVALID_EXPIRATION_DATE", "UNSUPPORTED_CARD_BRAND", "UNSUPPORTED_ENTRY_METHOD", "INVALID_ENCRYPTED_CARD", "INVALID_CARD", "PAYMENT_AMOUNT_MISMATCH", "GENERIC_DECLINE", "CVV_FAILURE", "ADDRESS_VERIFICATION_FAILURE", "INVALID_ACCOUNT", "CURRENCY_MISMATCH", "INSUFFICIENT_FUNDS", "INSUFFICIENT_PERMISSIONS", "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "INVALID_LOCATION", "TRANSACTION_LIMIT", "VOICE_FAILURE", "PAN_FAILURE", "EXPIRATION_FAILURE", "CARD_NOT_SUPPORTED", "READER_DECLINED", "INVALID_PIN", "MISSING_PIN", "MISSING_ACCOUNT_TYPE", "INVALID_POSTAL_CODE", "INVALID_FEES", "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "PAYMENT_LIMIT_EXCEEDED", "GIFT_CARD_AVAILABLE_AMOUNT", "ACCOUNT_UNUSABLE", "BUYER_REFUSED_PAYMENT", "DELAYED_TRANSACTION_EXPIRED", "DELAYED_TRANSACTION_CANCELED", "DELAYED_TRANSACTION_CAPTURED", "DELAYED_TRANSACTION_FAILED", "CARD_TOKEN_EXPIRED", "CARD_TOKEN_USED", "AMOUNT_TOO_HIGH", "UNSUPPORTED_INSTRUMENT_TYPE", "REFUND_AMOUNT_INVALID", "REFUND_ALREADY_PENDING", "PAYMENT_NOT_REFUNDABLE", "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "REFUND_DECLINED", "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "INVALID_CARD_DATA", "SOURCE_USED", "SOURCE_EXPIRED", "UNSUPPORTED_LOYALTY_REWARD_TIER", "LOCATION_MISMATCH", "ORDER_UNPAID_NOT_RETURNABLE", "IDEMPOTENCY_KEY_REUSED", "UNEXPECTED_VALUE", "SANDBOX_NOT_SUPPORTED", "INVALID_EMAIL_ADDRESS", "INVALID_PHONE_NUMBER", "CHECKOUT_EXPIRED", "BAD_CERTIFICATE", "INVALID_SQUARE_VERSION_FORMAT", "API_VERSION_INCOMPATIBLE", "CARD_PRESENCE_REQUIRED", "UNSUPPORTED_SOURCE_TYPE", "CARD_MISMATCH", "PLAID_ERROR", "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "PLAID_ERROR_RATE_LIMIT", "CARD_DECLINED", "VERIFY_CVV_FAILURE", "VERIFY_AVS_FAILURE", "CARD_DECLINED_CALL_ISSUER", "CARD_DECLINED_VERIFICATION_REQUIRED", "BAD_EXPIRATION", "CHIP_INSERTION_REQUIRED", "ALLOWABLE_PIN_TRIES_EXCEEDED", "RESERVATION_DECLINED", "UNKNOWN_BODY_PARAMETER", "NOT_FOUND", "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "REQUEST_ENTITY_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "UNPROCESSABLE_ENTITY", "RATE_LIMITED", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "TEMPORARY_ERROR", "GATEWAY_TIMEOUT"], "x-enum-elements": [{"name": "INTERNAL_SERVER_ERROR", "description": "A general server error occurred.", "error-category": "API_ERROR"}, {"name": "UNAUTHORIZED", "description": "A general authorization error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_EXPIRED", "description": "The provided access token has expired.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_REVOKED", "description": "The provided access token has been revoked.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "CLIENT_DISABLED", "description": "The provided client has been disabled.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "FORBIDDEN", "description": "A general access error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "INSUFFICIENT_SCOPES", "description": "The provided access token does not have permission\nto execute the requested action.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "APPLICATION_DISABLED", "description": "The calling application was disabled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_APPLICATION", "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_ACCESS_TOKEN", "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PROCESSING_NOT_ENABLED", "description": "The location provided in the API call is not\nenabled for credit card processing.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "description": "A required subscription was not found for the merchant", "error-category": "MERCHANT_SUBSCRIPTION_ERROR"}, {"name": "BAD_REQUEST", "description": "A general error occurred with the request.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MISSING_REQUIRED_PARAMETER", "description": "The request is missing a required path, query, or\nbody parameter.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INCORRECT_TYPE", "description": "The value provided in the request is the wrong\ntype. For example, a string instead of an integer.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME", "description": "Formatting for the provided time value is\nincorrect.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME_RANGE", "description": "The time range provided in the request is invalid.\nFor example, the end time is before the start time.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_VALUE", "description": "The provided value is invalid. For example,\nincluding `%` in a phone number.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CURSOR", "description": "The pagination cursor included in the request is\ninvalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNKNOWN_QUERY_PARAMETER", "description": "The query parameters provided is invalid for the\nrequested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICTING_PARAMETERS", "description": "One or more of the request parameters conflict with\neach other.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_JSON_BODY", "description": "The request body is not a JSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SORT_ORDER", "description": "The provided sort order is not a valid key.\nCurrently, sort order must be `ASC` or `DESC`.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_REGEX_MISMATCH", "description": "The provided value does not match an expected\nregular expression.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_SHORT", "description": "The provided string value is shorter than the\nminimum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LONG", "description": "The provided string value is longer than the\nmaximum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LOW", "description": "The provided value is less than the supported\nminimum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_HIGH", "description": "The provided value is greater than the supported\nmaximum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_EMPTY", "description": "The provided value has a default (empty) value\nsuch as a blank string.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_LONG", "description": "The provided array has too many elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_SHORT", "description": "The provided array has too few elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_EMPTY", "description": "The provided array is empty.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BOOLEAN", "description": "The endpoint expected the provided value to be a\nboolean.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_INTEGER", "description": "The endpoint expected the provided value to be an\ninteger.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_FLOAT", "description": "The endpoint expected the provided value to be a\nfloat.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_STRING", "description": "The endpoint expected the provided value to be a\nstring.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_OBJECT", "description": "The endpoint expected the provided value to be a\nJSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_ARRAY", "description": "The endpoint expected the provided value to be an\narray or list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_MAP", "description": "The endpoint expected the provided value to be a\nmap or associative array.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "description": "The endpoint expected the provided value to be an\narray encoded in base64.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ARRAY_VALUE", "description": "One or more objects in the array does not match the\narray type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ENUM_VALUE", "description": "The provided static string is not valid for the\nfield.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CONTENT_TYPE", "description": "Invalid content type header.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_FORM_VALUE", "description": "Only relevant for applications created prior to\n2016-03-30. Indicates there was an error while parsing form values.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_NOT_FOUND", "description": "The provided customer id can\'t be found in the merchant\'s customers list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ONE_INSTRUMENT_EXPECTED", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NO_FIELDS_SET", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "TOO_MANY_MAP_ENTRIES", "description": "Too many entries in the map field.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_SHORT", "description": "The length of one of the provided keys in the map is too short.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_LONG", "description": "The length of one of the provided keys in the map is too long.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_NAME", "description": "The provided customer does not have a recorded name.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_EMAIL", "description": "The provided customer does not have a recorded email.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PAUSE_LENGTH", "description": "The subscription cannot be paused longer than the duration of the current phase.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_DATE", "description": "The subscription cannot be paused/resumed on the given date.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_COUNTRY", "description": "The API request references an unsupported country.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CURRENCY", "description": "The API request references an unsupported currency.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_TTP_PIN_TOKEN", "description": "The payment was declined by the card issuer during an Apple Tap to Pay (TTP)\ntransaction with a request for the card\'s PIN. This code will be returned alongside\n`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an\nissuer-provided token in the `details` field that is needed to initiate the PIN\ncollection flow on the iOS device.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_EXPIRED", "description": "The card issuer declined the request because the card is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION", "description": "The expiration date for the payment card is invalid. For example,\nit indicates a date in the past.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION_YEAR", "description": "The expiration year for the payment card is invalid. For example,\nit indicates a year in the past or contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EXPIRATION_DATE", "description": "The expiration date for the payment card is invalid. For example,\nit contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CARD_BRAND", "description": "The credit card provided is not from a supported issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "UNSUPPORTED_ENTRY_METHOD", "description": "The entry method for the credit card (swipe, dip, tap) is not supported.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ENCRYPTED_CARD", "description": "The encrypted card information is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_CARD", "description": "The credit card cannot be validated based on the provided details.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_AMOUNT_MISMATCH", "description": "The payment was declined because there was a payment amount mismatch.\nThe money amount Square was expecting does not match the amount provided.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GENERIC_DECLINE", "description": "Square received a decline without any additional information.\nIf the payment information seems correct, the buyer can contact their\nissuer to ask for more information.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CVV_FAILURE", "description": "The card issuer declined the request because the CVV value is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ADDRESS_VERIFICATION_FAILURE", "description": "The card issuer declined the request because the postal code is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ACCOUNT", "description": "The issuer was not able to locate the account on record.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CURRENCY_MISMATCH", "description": "The currency associated with the payment is not valid for the provided\nfunding source. For example, a gift card funded in USD cannot be used to process\npayments in GBP.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_FUNDS", "description": "The funding source has insufficient funds to cover the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS", "description": "The Square account does not have the permissions to accept\nthis payment. For example, Square may limit which merchants are\nallowed to receive gift card payments.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "description": "The card issuer has declined the transaction due to restrictions on where the card can be used.\nFor example, a gift card is limited to a single merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_LOCATION", "description": "The Square account cannot take payments in the specified region.\nA Square account can take payments only from the region where the account was created.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "TRANSACTION_LIMIT", "description": "The card issuer has determined the payment amount is either too high or too low.\nThe API returns the error code mostly for credit cards (for example, the card reached\nthe credit limit). However, sometimes the issuer bank can indicate the error for debit\nor prepaid cards (for example, card has insufficient funds).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VOICE_FAILURE", "description": "The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAN_FAILURE", "description": "The specified card number is invalid. For example, it is of\nincorrect length or is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "EXPIRATION_FAILURE", "description": "The card expiration date is either invalid or indicates that the\ncard is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_NOT_SUPPORTED", "description": "The card is not supported either in the geographic region or by\nthe [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "READER_DECLINED", "description": "The Square Card Reader declined the payment for an unknown reason.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_PIN", "description": "The card issuer declined the request because the PIN is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_PIN", "description": "The payment is missing a required PIN.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_ACCOUNT_TYPE", "description": "The payment is missing a required ACCOUNT_TYPE parameter.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_POSTAL_CODE", "description": "The postal code is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_FEES", "description": "The app_fee_money on a payment is too high.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "description": "The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_LIMIT_EXCEEDED", "description": "Square declined the request because the payment amount exceeded the processing limit for this merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GIFT_CARD_AVAILABLE_AMOUNT", "description": "When a Gift Card is a payment source, you can allow taking a partial payment\nby adding the `accept_partial_authorization` parameter in the request.\nHowever, taking such a partial payment does not work if your request also includes\n`tip_money`, `app_fee_money`, or both. Square declines such payments and returns\nthe `GIFT_CARD_AVAILABLE_AMOUNT` error.\nFor more information, see\n[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ACCOUNT_UNUSABLE", "description": "The account provided cannot carry out transactions.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BUYER_REFUSED_PAYMENT", "description": "Bank account rejected or was not authorized for the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "DELAYED_TRANSACTION_EXPIRED", "description": "The application tried to update a delayed-capture payment that has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CANCELED", "description": "The application tried to cancel a delayed-capture payment that was already cancelled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CAPTURED", "description": "The application tried to capture a delayed-capture payment that was already captured.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_FAILED", "description": "The application tried to update a delayed-capture payment that failed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_EXPIRED", "description": "The provided card token (nonce) has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_USED", "description": "The provided card token (nonce) was already used to process the payment or refund.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "AMOUNT_TOO_HIGH", "description": "The requested payment amount is too high for the provided payment source.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_INSTRUMENT_TYPE", "description": "The API request references an unsupported instrument type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REFUND_AMOUNT_INVALID", "description": "The requested refund amount exceeds the amount available to refund.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ALREADY_PENDING", "description": "The payment already has a pending refund.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE", "description": "The payment is not refundable. For example, the payment is too old to be refunded.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "description": "The payment is not refundable because it has been disputed.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "description": "The payment is not refundable because the payment is approved and needs to be completed first before the refund is issued.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_DECLINED", "description": "Request failed - The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "description": "The Square account does not have the permissions to process this refund.", "error-category": "REFUND_ERROR"}, {"name": "INVALID_CARD_DATA", "description": "Generic error - the provided card data is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_USED", "description": "The provided source id was already used to create a card.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_EXPIRED", "description": "The provided source id has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_LOYALTY_REWARD_TIER", "description": "The referenced loyalty program reward tier is not supported.\nThis could happen if the reward tier created in a first party\napplication is incompatible with the Loyalty API.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "LOCATION_MISMATCH", "description": "Generic error - the given location does not matching what is expected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ORDER_UNPAID_NOT_RETURNABLE", "description": "The order attempting to be returned is not yet paid and cannot be returned.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "IDEMPOTENCY_KEY_REUSED", "description": "The provided idempotency key has already been used.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNEXPECTED_VALUE", "description": "General error - the value provided was unexpected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SANDBOX_NOT_SUPPORTED", "description": "The API request is not supported in sandbox.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EMAIL_ADDRESS", "description": "The provided email address is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PHONE_NUMBER", "description": "The provided phone number is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CHECKOUT_EXPIRED", "description": "The provided checkout URL has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "BAD_CERTIFICATE", "description": "Bad certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SQUARE_VERSION_FORMAT", "description": "The provided Square-Version is incorrectly formatted.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "API_VERSION_INCOMPATIBLE", "description": "The provided Square-Version is incompatible with the requested action.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PRESENCE_REQUIRED", "description": "The transaction requires that a card be present.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_SOURCE_TYPE", "description": "The API request references an unsupported source type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_MISMATCH", "description": "The provided card does not match what is expected.", "error-category": "REFUND_ERROR"}, {"name": "PLAID_ERROR", "description": "Generic plaid error", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "description": "Plaid error - ITEM_LOGIN_REQUIRED", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_RATE_LIMIT", "description": "Plaid error - RATE_LIMIT", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "CARD_DECLINED", "description": "The card was declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_CVV_FAILURE", "description": "The CVV could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_AVS_FAILURE", "description": "The AVS could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_CALL_ISSUER", "description": "The payment card was declined with a request\nfor the card holder to call the issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_VERIFICATION_REQUIRED", "description": "The payment card was declined with a request\nfor additional verification.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BAD_EXPIRATION", "description": "The card expiration date is either missing or\nincorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CHIP_INSERTION_REQUIRED", "description": "The card issuer requires that the card be read\nusing a chip reader.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ALLOWABLE_PIN_TRIES_EXCEEDED", "description": "The card has exhausted its available pin entry\nretries set by the card issuer. Resolving the error typically requires the\ncard holder to contact the card issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "RESERVATION_DECLINED", "description": "The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "UNKNOWN_BODY_PARAMETER", "description": "The body parameter is not recognized by the requested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_FOUND", "description": "Not Found - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "description": "Square could not find the associated Apple Pay certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "METHOD_NOT_ALLOWED", "description": "Method Not Allowed - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_ACCEPTABLE", "description": "Not Acceptable - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_TIMEOUT", "description": "Request Timeout - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICT", "description": "Conflict - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "GONE", "description": "The target resource is no longer available and this\ncondition is likely to be permanent.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_ENTITY_TOO_LARGE", "description": "Request Entity Too Large - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_MEDIA_TYPE", "description": "Unsupported Media Type - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNPROCESSABLE_ENTITY", "description": "Unprocessable Entity - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "RATE_LIMITED", "description": "Rate Limited - a general error occurred.", "error-category": "RATE_LIMIT_ERROR"}, {"name": "NOT_IMPLEMENTED", "description": "Not Implemented - a general error occurred.", "error-category": "API_ERROR"}, {"name": "BAD_GATEWAY", "description": "Bad Gateway - a general error occurred.", "error-category": "API_ERROR"}, {"name": "SERVICE_UNAVAILABLE", "description": "Service Unavailable - a general error occurred.", "error-category": "API_ERROR"}, {"name": "TEMPORARY_ERROR", "description": "A temporary internal error occurred. You can safely retry your call\nusing the same idempotency key.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GATEWAY_TIMEOUT", "description": "Gateway Timeout - a general error occurred.", "error-category": "API_ERROR"}], "description": "Indicates the specific error that occurred during a request to a\nSquare API.", "x-release-status": "PUBLIC"}, "detail": {"type": "string", "description": "A human-readable description of the error for debugging purposes."}, "field": {"type": "string", "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."}}}, "description": "Information about errors encountered during the request.", "readOnly": true}}}, "cash_details": {"type": "object", "description": "Stores details about a cash payment. Contains only non-confidential information. For more information, see \n[Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments).", "x-release-status": "PUBLIC", "required": ["buyer_supplied_money"], "properties": {"buyer_supplied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "bank_account_details": {"type": "object", "description": "Additional details about BANK_ACCOUNT type payments.", "x-release-status": "PUBLIC", "properties": {"bank_name": {"type": "string", "description": "The name of the bank associated with the bank account.", "maxLength": 100, "nullable": true}, "transfer_type": {"type": "string", "description": "The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.", "maxLength": 50, "nullable": true}, "account_ownership_type": {"type": "string", "description": "The ownership type of the bank account performing the transfer.\nThe type can be `INDIVIDUAL`, `COMPANY`, or `ACCOUNT_TYPE_UNKNOWN`.", "maxLength": 50, "nullable": true}, "fingerprint": {"type": "string", "description": "Uniquely identifies the bank account for this seller and can be used\nto determine if payments are from the same bank account.", "maxLength": 255, "nullable": true}, "country": {"type": "string", "description": "The two-letter ISO code representing the country the bank account is located in.", "minLength": 2, "maxLength": 2, "nullable": true}, "statement_description": {"type": "string", "description": "The statement description as sent to the bank.", "maxLength": 1000, "nullable": true}, "ach_details": {"type": "object", "description": "ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`.", "x-release-status": "PUBLIC", "properties": {"routing_number": {"type": "string", "description": "The routing number for the bank account.", "maxLength": 50, "nullable": true}, "account_number_suffix": {"type": "string", "description": "The last few digits of the bank account number.", "minLength": 1, "maxLength": 4, "nullable": true}, "account_type": {"type": "string", "description": "The type of the bank account performing the transfer. The account type can be `CHECKING`,\n`SAVINGS`, or `UNKNOWN`.", "maxLength": 50, "nullable": true}}}, "errors": {"type": "array", "items": {"type": "object", "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.", "x-release-status": "PUBLIC", "required": ["category", "code"], "properties": {"category": {"type": "string", "enum": ["API_ERROR", "AUTHENTICATION_ERROR", "INVALID_REQUEST_ERROR", "RATE_LIMIT_ERROR", "PAYMENT_METHOD_ERROR", "REFUND_ERROR", "MERCHANT_SUBSCRIPTION_ERROR", "EXTERNAL_VENDOR_ERROR"], "x-enum-elements": [{"name": "API_ERROR", "description": "An error occurred with the Connect API itself."}, {"name": "AUTHENTICATION_ERROR", "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header."}, {"name": "INVALID_REQUEST_ERROR", "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value."}, {"name": "RATE_LIMIT_ERROR", "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule."}, {"name": "PAYMENT_METHOD_ERROR", "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card\'s CVV\nor expiration date)."}, {"name": "REFUND_ERROR", "description": "An error occurred while attempting to process a refund."}, {"name": "MERCHANT_SUBSCRIPTION_ERROR", "description": "An error occurred when checking a merchant subscription status"}, {"name": "EXTERNAL_VENDOR_ERROR", "description": "An error that is returned from an external vendor\'s API"}], "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.", "x-release-status": "PUBLIC"}, "code": {"type": "string", "enum": ["INTERNAL_SERVER_ERROR", "UNAUTHORIZED", "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_REVOKED", "CLIENT_DISABLED", "FORBIDDEN", "INSUFFICIENT_SCOPES", "APPLICATION_DISABLED", "V1_APPLICATION", "V1_ACCESS_TOKEN", "CARD_PROCESSING_NOT_ENABLED", "MERCHANT_SUBSCRIPTION_NOT_FOUND", "BAD_REQUEST", "MISSING_REQUIRED_PARAMETER", "INCORRECT_TYPE", "INVALID_TIME", "INVALID_TIME_RANGE", "INVALID_VALUE", "INVALID_CURSOR", "UNKNOWN_QUERY_PARAMETER", "CONFLICTING_PARAMETERS", "EXPECTED_JSON_BODY", "INVALID_SORT_ORDER", "VALUE_REGEX_MISMATCH", "VALUE_TOO_SHORT", "VALUE_TOO_LONG", "VALUE_TOO_LOW", "VALUE_TOO_HIGH", "VALUE_EMPTY", "ARRAY_LENGTH_TOO_LONG", "ARRAY_LENGTH_TOO_SHORT", "ARRAY_EMPTY", "EXPECTED_BOOLEAN", "EXPECTED_INTEGER", "EXPECTED_FLOAT", "EXPECTED_STRING", "EXPECTED_OBJECT", "EXPECTED_ARRAY", "EXPECTED_MAP", "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "INVALID_ARRAY_VALUE", "INVALID_ENUM_VALUE", "INVALID_CONTENT_TYPE", "INVALID_FORM_VALUE", "CUSTOMER_NOT_FOUND", "ONE_INSTRUMENT_EXPECTED", "NO_FIELDS_SET", "TOO_MANY_MAP_ENTRIES", "MAP_KEY_LENGTH_TOO_SHORT", "MAP_KEY_LENGTH_TOO_LONG", "CUSTOMER_MISSING_NAME", "CUSTOMER_MISSING_EMAIL", "INVALID_PAUSE_LENGTH", "INVALID_DATE", "UNSUPPORTED_COUNTRY", "UNSUPPORTED_CURRENCY", "APPLE_TTP_PIN_TOKEN", "CARD_EXPIRED", "INVALID_EXPIRATION", "INVALID_EXPIRATION_YEAR", "INVALID_EXPIRATION_DATE", "UNSUPPORTED_CARD_BRAND", "UNSUPPORTED_ENTRY_METHOD", "INVALID_ENCRYPTED_CARD", "INVALID_CARD", "PAYMENT_AMOUNT_MISMATCH", "GENERIC_DECLINE", "CVV_FAILURE", "ADDRESS_VERIFICATION_FAILURE", "INVALID_ACCOUNT", "CURRENCY_MISMATCH", "INSUFFICIENT_FUNDS", "INSUFFICIENT_PERMISSIONS", "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "INVALID_LOCATION", "TRANSACTION_LIMIT", "VOICE_FAILURE", "PAN_FAILURE", "EXPIRATION_FAILURE", "CARD_NOT_SUPPORTED", "READER_DECLINED", "INVALID_PIN", "MISSING_PIN", "MISSING_ACCOUNT_TYPE", "INVALID_POSTAL_CODE", "INVALID_FEES", "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "PAYMENT_LIMIT_EXCEEDED", "GIFT_CARD_AVAILABLE_AMOUNT", "ACCOUNT_UNUSABLE", "BUYER_REFUSED_PAYMENT", "DELAYED_TRANSACTION_EXPIRED", "DELAYED_TRANSACTION_CANCELED", "DELAYED_TRANSACTION_CAPTURED", "DELAYED_TRANSACTION_FAILED", "CARD_TOKEN_EXPIRED", "CARD_TOKEN_USED", "AMOUNT_TOO_HIGH", "UNSUPPORTED_INSTRUMENT_TYPE", "REFUND_AMOUNT_INVALID", "REFUND_ALREADY_PENDING", "PAYMENT_NOT_REFUNDABLE", "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "REFUND_DECLINED", "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "INVALID_CARD_DATA", "SOURCE_USED", "SOURCE_EXPIRED", "UNSUPPORTED_LOYALTY_REWARD_TIER", "LOCATION_MISMATCH", "ORDER_UNPAID_NOT_RETURNABLE", "IDEMPOTENCY_KEY_REUSED", "UNEXPECTED_VALUE", "SANDBOX_NOT_SUPPORTED", "INVALID_EMAIL_ADDRESS", "INVALID_PHONE_NUMBER", "CHECKOUT_EXPIRED", "BAD_CERTIFICATE", "INVALID_SQUARE_VERSION_FORMAT", "API_VERSION_INCOMPATIBLE", "CARD_PRESENCE_REQUIRED", "UNSUPPORTED_SOURCE_TYPE", "CARD_MISMATCH", "PLAID_ERROR", "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "PLAID_ERROR_RATE_LIMIT", "CARD_DECLINED", "VERIFY_CVV_FAILURE", "VERIFY_AVS_FAILURE", "CARD_DECLINED_CALL_ISSUER", "CARD_DECLINED_VERIFICATION_REQUIRED", "BAD_EXPIRATION", "CHIP_INSERTION_REQUIRED", "ALLOWABLE_PIN_TRIES_EXCEEDED", "RESERVATION_DECLINED", "UNKNOWN_BODY_PARAMETER", "NOT_FOUND", "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "REQUEST_ENTITY_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "UNPROCESSABLE_ENTITY", "RATE_LIMITED", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "TEMPORARY_ERROR", "GATEWAY_TIMEOUT"], "x-enum-elements": [{"name": "INTERNAL_SERVER_ERROR", "description": "A general server error occurred.", "error-category": "API_ERROR"}, {"name": "UNAUTHORIZED", "description": "A general authorization error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_EXPIRED", "description": "The provided access token has expired.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_REVOKED", "description": "The provided access token has been revoked.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "CLIENT_DISABLED", "description": "The provided client has been disabled.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "FORBIDDEN", "description": "A general access error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "INSUFFICIENT_SCOPES", "description": "The provided access token does not have permission\nto execute the requested action.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "APPLICATION_DISABLED", "description": "The calling application was disabled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_APPLICATION", "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_ACCESS_TOKEN", "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PROCESSING_NOT_ENABLED", "description": "The location provided in the API call is not\nenabled for credit card processing.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "description": "A required subscription was not found for the merchant", "error-category": "MERCHANT_SUBSCRIPTION_ERROR"}, {"name": "BAD_REQUEST", "description": "A general error occurred with the request.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MISSING_REQUIRED_PARAMETER", "description": "The request is missing a required path, query, or\nbody parameter.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INCORRECT_TYPE", "description": "The value provided in the request is the wrong\ntype. For example, a string instead of an integer.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME", "description": "Formatting for the provided time value is\nincorrect.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME_RANGE", "description": "The time range provided in the request is invalid.\nFor example, the end time is before the start time.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_VALUE", "description": "The provided value is invalid. For example,\nincluding `%` in a phone number.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CURSOR", "description": "The pagination cursor included in the request is\ninvalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNKNOWN_QUERY_PARAMETER", "description": "The query parameters provided is invalid for the\nrequested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICTING_PARAMETERS", "description": "One or more of the request parameters conflict with\neach other.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_JSON_BODY", "description": "The request body is not a JSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SORT_ORDER", "description": "The provided sort order is not a valid key.\nCurrently, sort order must be `ASC` or `DESC`.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_REGEX_MISMATCH", "description": "The provided value does not match an expected\nregular expression.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_SHORT", "description": "The provided string value is shorter than the\nminimum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LONG", "description": "The provided string value is longer than the\nmaximum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LOW", "description": "The provided value is less than the supported\nminimum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_HIGH", "description": "The provided value is greater than the supported\nmaximum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_EMPTY", "description": "The provided value has a default (empty) value\nsuch as a blank string.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_LONG", "description": "The provided array has too many elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_SHORT", "description": "The provided array has too few elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_EMPTY", "description": "The provided array is empty.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BOOLEAN", "description": "The endpoint expected the provided value to be a\nboolean.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_INTEGER", "description": "The endpoint expected the provided value to be an\ninteger.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_FLOAT", "description": "The endpoint expected the provided value to be a\nfloat.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_STRING", "description": "The endpoint expected the provided value to be a\nstring.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_OBJECT", "description": "The endpoint expected the provided value to be a\nJSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_ARRAY", "description": "The endpoint expected the provided value to be an\narray or list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_MAP", "description": "The endpoint expected the provided value to be a\nmap or associative array.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "description": "The endpoint expected the provided value to be an\narray encoded in base64.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ARRAY_VALUE", "description": "One or more objects in the array does not match the\narray type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ENUM_VALUE", "description": "The provided static string is not valid for the\nfield.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CONTENT_TYPE", "description": "Invalid content type header.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_FORM_VALUE", "description": "Only relevant for applications created prior to\n2016-03-30. Indicates there was an error while parsing form values.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_NOT_FOUND", "description": "The provided customer id can\'t be found in the merchant\'s customers list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ONE_INSTRUMENT_EXPECTED", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NO_FIELDS_SET", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "TOO_MANY_MAP_ENTRIES", "description": "Too many entries in the map field.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_SHORT", "description": "The length of one of the provided keys in the map is too short.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_LONG", "description": "The length of one of the provided keys in the map is too long.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_NAME", "description": "The provided customer does not have a recorded name.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_EMAIL", "description": "The provided customer does not have a recorded email.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PAUSE_LENGTH", "description": "The subscription cannot be paused longer than the duration of the current phase.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_DATE", "description": "The subscription cannot be paused/resumed on the given date.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_COUNTRY", "description": "The API request references an unsupported country.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CURRENCY", "description": "The API request references an unsupported currency.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_TTP_PIN_TOKEN", "description": "The payment was declined by the card issuer during an Apple Tap to Pay (TTP)\ntransaction with a request for the card\'s PIN. This code will be returned alongside\n`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an\nissuer-provided token in the `details` field that is needed to initiate the PIN\ncollection flow on the iOS device.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_EXPIRED", "description": "The card issuer declined the request because the card is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION", "description": "The expiration date for the payment card is invalid. For example,\nit indicates a date in the past.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION_YEAR", "description": "The expiration year for the payment card is invalid. For example,\nit indicates a year in the past or contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EXPIRATION_DATE", "description": "The expiration date for the payment card is invalid. For example,\nit contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CARD_BRAND", "description": "The credit card provided is not from a supported issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "UNSUPPORTED_ENTRY_METHOD", "description": "The entry method for the credit card (swipe, dip, tap) is not supported.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ENCRYPTED_CARD", "description": "The encrypted card information is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_CARD", "description": "The credit card cannot be validated based on the provided details.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_AMOUNT_MISMATCH", "description": "The payment was declined because there was a payment amount mismatch.\nThe money amount Square was expecting does not match the amount provided.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GENERIC_DECLINE", "description": "Square received a decline without any additional information.\nIf the payment information seems correct, the buyer can contact their\nissuer to ask for more information.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CVV_FAILURE", "description": "The card issuer declined the request because the CVV value is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ADDRESS_VERIFICATION_FAILURE", "description": "The card issuer declined the request because the postal code is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ACCOUNT", "description": "The issuer was not able to locate the account on record.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CURRENCY_MISMATCH", "description": "The currency associated with the payment is not valid for the provided\nfunding source. For example, a gift card funded in USD cannot be used to process\npayments in GBP.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_FUNDS", "description": "The funding source has insufficient funds to cover the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS", "description": "The Square account does not have the permissions to accept\nthis payment. For example, Square may limit which merchants are\nallowed to receive gift card payments.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "description": "The card issuer has declined the transaction due to restrictions on where the card can be used.\nFor example, a gift card is limited to a single merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_LOCATION", "description": "The Square account cannot take payments in the specified region.\nA Square account can take payments only from the region where the account was created.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "TRANSACTION_LIMIT", "description": "The card issuer has determined the payment amount is either too high or too low.\nThe API returns the error code mostly for credit cards (for example, the card reached\nthe credit limit). However, sometimes the issuer bank can indicate the error for debit\nor prepaid cards (for example, card has insufficient funds).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VOICE_FAILURE", "description": "The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAN_FAILURE", "description": "The specified card number is invalid. For example, it is of\nincorrect length or is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "EXPIRATION_FAILURE", "description": "The card expiration date is either invalid or indicates that the\ncard is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_NOT_SUPPORTED", "description": "The card is not supported either in the geographic region or by\nthe [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "READER_DECLINED", "description": "The Square Card Reader declined the payment for an unknown reason.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_PIN", "description": "The card issuer declined the request because the PIN is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_PIN", "description": "The payment is missing a required PIN.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_ACCOUNT_TYPE", "description": "The payment is missing a required ACCOUNT_TYPE parameter.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_POSTAL_CODE", "description": "The postal code is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_FEES", "description": "The app_fee_money on a payment is too high.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "description": "The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_LIMIT_EXCEEDED", "description": "Square declined the request because the payment amount exceeded the processing limit for this merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GIFT_CARD_AVAILABLE_AMOUNT", "description": "When a Gift Card is a payment source, you can allow taking a partial payment\nby adding the `accept_partial_authorization` parameter in the request.\nHowever, taking such a partial payment does not work if your request also includes\n`tip_money`, `app_fee_money`, or both. Square declines such payments and returns\nthe `GIFT_CARD_AVAILABLE_AMOUNT` error.\nFor more information, see\n[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ACCOUNT_UNUSABLE", "description": "The account provided cannot carry out transactions.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BUYER_REFUSED_PAYMENT", "description": "Bank account rejected or was not authorized for the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "DELAYED_TRANSACTION_EXPIRED", "description": "The application tried to update a delayed-capture payment that has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CANCELED", "description": "The application tried to cancel a delayed-capture payment that was already cancelled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CAPTURED", "description": "The application tried to capture a delayed-capture payment that was already captured.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_FAILED", "description": "The application tried to update a delayed-capture payment that failed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_EXPIRED", "description": "The provided card token (nonce) has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_USED", "description": "The provided card token (nonce) was already used to process the payment or refund.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "AMOUNT_TOO_HIGH", "description": "The requested payment amount is too high for the provided payment source.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_INSTRUMENT_TYPE", "description": "The API request references an unsupported instrument type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REFUND_AMOUNT_INVALID", "description": "The requested refund amount exceeds the amount available to refund.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ALREADY_PENDING", "description": "The payment already has a pending refund.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE", "description": "The payment is not refundable. For example, the payment is too old to be refunded.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "description": "The payment is not refundable because it has been disputed.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "description": "The payment is not refundable because the payment is approved and needs to be completed first before the refund is issued.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_DECLINED", "description": "Request failed - The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "description": "The Square account does not have the permissions to process this refund.", "error-category": "REFUND_ERROR"}, {"name": "INVALID_CARD_DATA", "description": "Generic error - the provided card data is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_USED", "description": "The provided source id was already used to create a card.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_EXPIRED", "description": "The provided source id has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_LOYALTY_REWARD_TIER", "description": "The referenced loyalty program reward tier is not supported.\nThis could happen if the reward tier created in a first party\napplication is incompatible with the Loyalty API.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "LOCATION_MISMATCH", "description": "Generic error - the given location does not matching what is expected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ORDER_UNPAID_NOT_RETURNABLE", "description": "The order attempting to be returned is not yet paid and cannot be returned.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "IDEMPOTENCY_KEY_REUSED", "description": "The provided idempotency key has already been used.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNEXPECTED_VALUE", "description": "General error - the value provided was unexpected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SANDBOX_NOT_SUPPORTED", "description": "The API request is not supported in sandbox.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EMAIL_ADDRESS", "description": "The provided email address is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PHONE_NUMBER", "description": "The provided phone number is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CHECKOUT_EXPIRED", "description": "The provided checkout URL has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "BAD_CERTIFICATE", "description": "Bad certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SQUARE_VERSION_FORMAT", "description": "The provided Square-Version is incorrectly formatted.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "API_VERSION_INCOMPATIBLE", "description": "The provided Square-Version is incompatible with the requested action.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PRESENCE_REQUIRED", "description": "The transaction requires that a card be present.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_SOURCE_TYPE", "description": "The API request references an unsupported source type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_MISMATCH", "description": "The provided card does not match what is expected.", "error-category": "REFUND_ERROR"}, {"name": "PLAID_ERROR", "description": "Generic plaid error", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "description": "Plaid error - ITEM_LOGIN_REQUIRED", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_RATE_LIMIT", "description": "Plaid error - RATE_LIMIT", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "CARD_DECLINED", "description": "The card was declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_CVV_FAILURE", "description": "The CVV could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_AVS_FAILURE", "description": "The AVS could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_CALL_ISSUER", "description": "The payment card was declined with a request\nfor the card holder to call the issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_VERIFICATION_REQUIRED", "description": "The payment card was declined with a request\nfor additional verification.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BAD_EXPIRATION", "description": "The card expiration date is either missing or\nincorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CHIP_INSERTION_REQUIRED", "description": "The card issuer requires that the card be read\nusing a chip reader.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ALLOWABLE_PIN_TRIES_EXCEEDED", "description": "The card has exhausted its available pin entry\nretries set by the card issuer. Resolving the error typically requires the\ncard holder to contact the card issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "RESERVATION_DECLINED", "description": "The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "UNKNOWN_BODY_PARAMETER", "description": "The body parameter is not recognized by the requested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_FOUND", "description": "Not Found - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "description": "Square could not find the associated Apple Pay certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "METHOD_NOT_ALLOWED", "description": "Method Not Allowed - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_ACCEPTABLE", "description": "Not Acceptable - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_TIMEOUT", "description": "Request Timeout - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICT", "description": "Conflict - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "GONE", "description": "The target resource is no longer available and this\ncondition is likely to be permanent.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_ENTITY_TOO_LARGE", "description": "Request Entity Too Large - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_MEDIA_TYPE", "description": "Unsupported Media Type - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNPROCESSABLE_ENTITY", "description": "Unprocessable Entity - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "RATE_LIMITED", "description": "Rate Limited - a general error occurred.", "error-category": "RATE_LIMIT_ERROR"}, {"name": "NOT_IMPLEMENTED", "description": "Not Implemented - a general error occurred.", "error-category": "API_ERROR"}, {"name": "BAD_GATEWAY", "description": "Bad Gateway - a general error occurred.", "error-category": "API_ERROR"}, {"name": "SERVICE_UNAVAILABLE", "description": "Service Unavailable - a general error occurred.", "error-category": "API_ERROR"}, {"name": "TEMPORARY_ERROR", "description": "A temporary internal error occurred. You can safely retry your call\nusing the same idempotency key.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GATEWAY_TIMEOUT", "description": "Gateway Timeout - a general error occurred.", "error-category": "API_ERROR"}], "description": "Indicates the specific error that occurred during a request to a\nSquare API.", "x-release-status": "PUBLIC"}, "detail": {"type": "string", "description": "A human-readable description of the error for debugging purposes."}, "field": {"type": "string", "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."}}}, "description": "Information about errors encountered during the request.", "nullable": true}}}, "external_details": {"type": "object", "description": "Stores details about an external payment. Contains only non-confidential information.\nFor more information, see \n[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).", "x-release-status": "PUBLIC", "required": ["type", "source"], "properties": {"type": {"type": "string", "description": "The type of external payment the seller received. It can be one of the following:\n- CHECK - Paid using a physical check.\n- BANK_TRANSFER - Paid using external bank transfer.\n- OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card.\n- CRYPTO - Paid using a crypto currency.\n- SQUARE_CASH - Paid using Square Cash App.\n- SOCIAL - Paid using peer-to-peer payment applications.\n- EXTERNAL - A third-party application gathered this payment outside of Square.\n- EMONEY - Paid using an E-money provider.\n- CARD - A credit or debit card that Square does not support.\n- STORED_BALANCE - Use for house accounts, store credit, and so forth.\n- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals\n- OTHER - A type not listed here.", "maxLength": 50}, "source": {"type": "string", "description": "A description of the external payment source. For example, \n"Food Delivery Service".", "maxLength": 255}, "source_id": {"type": "string", "description": "An ID to associate the payment to its originating source.", "maxLength": 255, "nullable": true}, "source_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "wallet_details": {"type": "object", "description": "Additional details about `WALLET` type payments. Contains only non-confidential information.", "x-release-status": "PUBLIC", "properties": {"status": {"type": "string", "description": "The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or\n`FAILED`.", "maxLength": 50, "nullable": true}, "brand": {"type": "string", "description": "The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`,\n`RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`.", "maxLength": 50, "nullable": true}, "cash_app_details": {"type": "object", "description": "Additional details about `WALLET` type payments with the `brand` of `CASH_APP`.", "x-release-status": "PUBLIC", "properties": {"buyer_full_name": {"type": "string", "description": "The name of the Cash App account holder.", "maxLength": 255, "nullable": true}, "buyer_country_code": {"type": "string", "description": "The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.\n\nFor possible values, see [Country](entity:Country).", "minLength": 2, "maxLength": 2, "nullable": true}, "buyer_cashtag": {"type": "string", "description": "$Cashtag of the Cash App account holder.", "minLength": 1, "maxLength": 21, "readOnly": true}}}}}, "buy_now_pay_later_details": {"type": "object", "description": "Additional details about a Buy Now Pay Later payment type.", "x-release-status": "PUBLIC", "properties": {"brand": {"type": "string", "description": "The brand used for the Buy Now Pay Later payment.\nThe brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`.", "maxLength": 50, "nullable": true}, "afterpay_details": {"type": "object", "description": "Additional details about Afterpay payments.", "x-release-status": "PUBLIC", "properties": {"email_address": {"type": "string", "description": "Email address on the buyer\'s Afterpay account.", "maxLength": 255, "nullable": true}}}, "clearpay_details": {"type": "object", "description": "Additional details about Clearpay payments.", "x-release-status": "PUBLIC", "properties": {"email_address": {"type": "string", "description": "Email address on the buyer\'s Clearpay account.", "maxLength": 255, "nullable": true}}}}}, "square_account_details": {"type": "object", "description": "Additional details about Square Account payments.", "x-release-status": "PUBLIC", "properties": {"payment_source_token": {"type": "string", "description": "Unique identifier for the payment source used for this payment.", "maxLength": 255, "nullable": true}, "errors": {"type": "array", "items": {"type": "object", "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.", "x-release-status": "PUBLIC", "required": ["category", "code"], "properties": {"category": {"type": "string", "enum": ["API_ERROR", "AUTHENTICATION_ERROR", "INVALID_REQUEST_ERROR", "RATE_LIMIT_ERROR", "PAYMENT_METHOD_ERROR", "REFUND_ERROR", "MERCHANT_SUBSCRIPTION_ERROR", "EXTERNAL_VENDOR_ERROR"], "x-enum-elements": [{"name": "API_ERROR", "description": "An error occurred with the Connect API itself."}, {"name": "AUTHENTICATION_ERROR", "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header."}, {"name": "INVALID_REQUEST_ERROR", "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value."}, {"name": "RATE_LIMIT_ERROR", "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule."}, {"name": "PAYMENT_METHOD_ERROR", "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card\'s CVV\nor expiration date)."}, {"name": "REFUND_ERROR", "description": "An error occurred while attempting to process a refund."}, {"name": "MERCHANT_SUBSCRIPTION_ERROR", "description": "An error occurred when checking a merchant subscription status"}, {"name": "EXTERNAL_VENDOR_ERROR", "description": "An error that is returned from an external vendor\'s API"}], "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.", "x-release-status": "PUBLIC"}, "code": {"type": "string", "enum": ["INTERNAL_SERVER_ERROR", "UNAUTHORIZED", "ACCESS_TOKEN_EXPIRED", "ACCESS_TOKEN_REVOKED", "CLIENT_DISABLED", "FORBIDDEN", "INSUFFICIENT_SCOPES", "APPLICATION_DISABLED", "V1_APPLICATION", "V1_ACCESS_TOKEN", "CARD_PROCESSING_NOT_ENABLED", "MERCHANT_SUBSCRIPTION_NOT_FOUND", "BAD_REQUEST", "MISSING_REQUIRED_PARAMETER", "INCORRECT_TYPE", "INVALID_TIME", "INVALID_TIME_RANGE", "INVALID_VALUE", "INVALID_CURSOR", "UNKNOWN_QUERY_PARAMETER", "CONFLICTING_PARAMETERS", "EXPECTED_JSON_BODY", "INVALID_SORT_ORDER", "VALUE_REGEX_MISMATCH", "VALUE_TOO_SHORT", "VALUE_TOO_LONG", "VALUE_TOO_LOW", "VALUE_TOO_HIGH", "VALUE_EMPTY", "ARRAY_LENGTH_TOO_LONG", "ARRAY_LENGTH_TOO_SHORT", "ARRAY_EMPTY", "EXPECTED_BOOLEAN", "EXPECTED_INTEGER", "EXPECTED_FLOAT", "EXPECTED_STRING", "EXPECTED_OBJECT", "EXPECTED_ARRAY", "EXPECTED_MAP", "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "INVALID_ARRAY_VALUE", "INVALID_ENUM_VALUE", "INVALID_CONTENT_TYPE", "INVALID_FORM_VALUE", "CUSTOMER_NOT_FOUND", "ONE_INSTRUMENT_EXPECTED", "NO_FIELDS_SET", "TOO_MANY_MAP_ENTRIES", "MAP_KEY_LENGTH_TOO_SHORT", "MAP_KEY_LENGTH_TOO_LONG", "CUSTOMER_MISSING_NAME", "CUSTOMER_MISSING_EMAIL", "INVALID_PAUSE_LENGTH", "INVALID_DATE", "UNSUPPORTED_COUNTRY", "UNSUPPORTED_CURRENCY", "APPLE_TTP_PIN_TOKEN", "CARD_EXPIRED", "INVALID_EXPIRATION", "INVALID_EXPIRATION_YEAR", "INVALID_EXPIRATION_DATE", "UNSUPPORTED_CARD_BRAND", "UNSUPPORTED_ENTRY_METHOD", "INVALID_ENCRYPTED_CARD", "INVALID_CARD", "PAYMENT_AMOUNT_MISMATCH", "GENERIC_DECLINE", "CVV_FAILURE", "ADDRESS_VERIFICATION_FAILURE", "INVALID_ACCOUNT", "CURRENCY_MISMATCH", "INSUFFICIENT_FUNDS", "INSUFFICIENT_PERMISSIONS", "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "INVALID_LOCATION", "TRANSACTION_LIMIT", "VOICE_FAILURE", "PAN_FAILURE", "EXPIRATION_FAILURE", "CARD_NOT_SUPPORTED", "READER_DECLINED", "INVALID_PIN", "MISSING_PIN", "MISSING_ACCOUNT_TYPE", "INVALID_POSTAL_CODE", "INVALID_FEES", "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "PAYMENT_LIMIT_EXCEEDED", "GIFT_CARD_AVAILABLE_AMOUNT", "ACCOUNT_UNUSABLE", "BUYER_REFUSED_PAYMENT", "DELAYED_TRANSACTION_EXPIRED", "DELAYED_TRANSACTION_CANCELED", "DELAYED_TRANSACTION_CAPTURED", "DELAYED_TRANSACTION_FAILED", "CARD_TOKEN_EXPIRED", "CARD_TOKEN_USED", "AMOUNT_TOO_HIGH", "UNSUPPORTED_INSTRUMENT_TYPE", "REFUND_AMOUNT_INVALID", "REFUND_ALREADY_PENDING", "PAYMENT_NOT_REFUNDABLE", "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "REFUND_DECLINED", "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "INVALID_CARD_DATA", "SOURCE_USED", "SOURCE_EXPIRED", "UNSUPPORTED_LOYALTY_REWARD_TIER", "LOCATION_MISMATCH", "ORDER_UNPAID_NOT_RETURNABLE", "IDEMPOTENCY_KEY_REUSED", "UNEXPECTED_VALUE", "SANDBOX_NOT_SUPPORTED", "INVALID_EMAIL_ADDRESS", "INVALID_PHONE_NUMBER", "CHECKOUT_EXPIRED", "BAD_CERTIFICATE", "INVALID_SQUARE_VERSION_FORMAT", "API_VERSION_INCOMPATIBLE", "CARD_PRESENCE_REQUIRED", "UNSUPPORTED_SOURCE_TYPE", "CARD_MISMATCH", "PLAID_ERROR", "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "PLAID_ERROR_RATE_LIMIT", "CARD_DECLINED", "VERIFY_CVV_FAILURE", "VERIFY_AVS_FAILURE", "CARD_DECLINED_CALL_ISSUER", "CARD_DECLINED_VERIFICATION_REQUIRED", "BAD_EXPIRATION", "CHIP_INSERTION_REQUIRED", "ALLOWABLE_PIN_TRIES_EXCEEDED", "RESERVATION_DECLINED", "UNKNOWN_BODY_PARAMETER", "NOT_FOUND", "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "REQUEST_ENTITY_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "UNPROCESSABLE_ENTITY", "RATE_LIMITED", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "TEMPORARY_ERROR", "GATEWAY_TIMEOUT"], "x-enum-elements": [{"name": "INTERNAL_SERVER_ERROR", "description": "A general server error occurred.", "error-category": "API_ERROR"}, {"name": "UNAUTHORIZED", "description": "A general authorization error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_EXPIRED", "description": "The provided access token has expired.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "ACCESS_TOKEN_REVOKED", "description": "The provided access token has been revoked.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "CLIENT_DISABLED", "description": "The provided client has been disabled.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "FORBIDDEN", "description": "A general access error occurred.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "INSUFFICIENT_SCOPES", "description": "The provided access token does not have permission\nto execute the requested action.", "error-category": "AUTHENTICATION_ERROR"}, {"name": "APPLICATION_DISABLED", "description": "The calling application was disabled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_APPLICATION", "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "V1_ACCESS_TOKEN", "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PROCESSING_NOT_ENABLED", "description": "The location provided in the API call is not\nenabled for credit card processing.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "description": "A required subscription was not found for the merchant", "error-category": "MERCHANT_SUBSCRIPTION_ERROR"}, {"name": "BAD_REQUEST", "description": "A general error occurred with the request.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MISSING_REQUIRED_PARAMETER", "description": "The request is missing a required path, query, or\nbody parameter.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INCORRECT_TYPE", "description": "The value provided in the request is the wrong\ntype. For example, a string instead of an integer.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME", "description": "Formatting for the provided time value is\nincorrect.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_TIME_RANGE", "description": "The time range provided in the request is invalid.\nFor example, the end time is before the start time.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_VALUE", "description": "The provided value is invalid. For example,\nincluding `%` in a phone number.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CURSOR", "description": "The pagination cursor included in the request is\ninvalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNKNOWN_QUERY_PARAMETER", "description": "The query parameters provided is invalid for the\nrequested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICTING_PARAMETERS", "description": "One or more of the request parameters conflict with\neach other.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_JSON_BODY", "description": "The request body is not a JSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SORT_ORDER", "description": "The provided sort order is not a valid key.\nCurrently, sort order must be `ASC` or `DESC`.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_REGEX_MISMATCH", "description": "The provided value does not match an expected\nregular expression.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_SHORT", "description": "The provided string value is shorter than the\nminimum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LONG", "description": "The provided string value is longer than the\nmaximum length allowed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_LOW", "description": "The provided value is less than the supported\nminimum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_TOO_HIGH", "description": "The provided value is greater than the supported\nmaximum.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "VALUE_EMPTY", "description": "The provided value has a default (empty) value\nsuch as a blank string.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_LONG", "description": "The provided array has too many elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_LENGTH_TOO_SHORT", "description": "The provided array has too few elements.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ARRAY_EMPTY", "description": "The provided array is empty.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BOOLEAN", "description": "The endpoint expected the provided value to be a\nboolean.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_INTEGER", "description": "The endpoint expected the provided value to be an\ninteger.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_FLOAT", "description": "The endpoint expected the provided value to be a\nfloat.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_STRING", "description": "The endpoint expected the provided value to be a\nstring.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_OBJECT", "description": "The endpoint expected the provided value to be a\nJSON object.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_ARRAY", "description": "The endpoint expected the provided value to be an\narray or list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_MAP", "description": "The endpoint expected the provided value to be a\nmap or associative array.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", "description": "The endpoint expected the provided value to be an\narray encoded in base64.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ARRAY_VALUE", "description": "One or more objects in the array does not match the\narray type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_ENUM_VALUE", "description": "The provided static string is not valid for the\nfield.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_CONTENT_TYPE", "description": "Invalid content type header.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_FORM_VALUE", "description": "Only relevant for applications created prior to\n2016-03-30. Indicates there was an error while parsing form values.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_NOT_FOUND", "description": "The provided customer id can\'t be found in the merchant\'s customers list.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ONE_INSTRUMENT_EXPECTED", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NO_FIELDS_SET", "description": "A general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "TOO_MANY_MAP_ENTRIES", "description": "Too many entries in the map field.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_SHORT", "description": "The length of one of the provided keys in the map is too short.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "MAP_KEY_LENGTH_TOO_LONG", "description": "The length of one of the provided keys in the map is too long.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_NAME", "description": "The provided customer does not have a recorded name.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CUSTOMER_MISSING_EMAIL", "description": "The provided customer does not have a recorded email.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PAUSE_LENGTH", "description": "The subscription cannot be paused longer than the duration of the current phase.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_DATE", "description": "The subscription cannot be paused/resumed on the given date.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_COUNTRY", "description": "The API request references an unsupported country.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CURRENCY", "description": "The API request references an unsupported currency.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_TTP_PIN_TOKEN", "description": "The payment was declined by the card issuer during an Apple Tap to Pay (TTP)\ntransaction with a request for the card\'s PIN. This code will be returned alongside\n`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an\nissuer-provided token in the `details` field that is needed to initiate the PIN\ncollection flow on the iOS device.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_EXPIRED", "description": "The card issuer declined the request because the card is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION", "description": "The expiration date for the payment card is invalid. For example,\nit indicates a date in the past.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_EXPIRATION_YEAR", "description": "The expiration year for the payment card is invalid. For example,\nit indicates a year in the past or contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EXPIRATION_DATE", "description": "The expiration date for the payment card is invalid. For example,\nit contains invalid characters.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_CARD_BRAND", "description": "The credit card provided is not from a supported issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "UNSUPPORTED_ENTRY_METHOD", "description": "The entry method for the credit card (swipe, dip, tap) is not supported.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ENCRYPTED_CARD", "description": "The encrypted card information is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_CARD", "description": "The credit card cannot be validated based on the provided details.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_AMOUNT_MISMATCH", "description": "The payment was declined because there was a payment amount mismatch.\nThe money amount Square was expecting does not match the amount provided.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GENERIC_DECLINE", "description": "Square received a decline without any additional information.\nIf the payment information seems correct, the buyer can contact their\nissuer to ask for more information.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CVV_FAILURE", "description": "The card issuer declined the request because the CVV value is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ADDRESS_VERIFICATION_FAILURE", "description": "The card issuer declined the request because the postal code is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_ACCOUNT", "description": "The issuer was not able to locate the account on record.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CURRENCY_MISMATCH", "description": "The currency associated with the payment is not valid for the provided\nfunding source. For example, a gift card funded in USD cannot be used to process\npayments in GBP.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_FUNDS", "description": "The funding source has insufficient funds to cover the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS", "description": "The Square account does not have the permissions to accept\nthis payment. For example, Square may limit which merchants are\nallowed to receive gift card payments.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARDHOLDER_INSUFFICIENT_PERMISSIONS", "description": "The card issuer has declined the transaction due to restrictions on where the card can be used.\nFor example, a gift card is limited to a single merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_LOCATION", "description": "The Square account cannot take payments in the specified region.\nA Square account can take payments only from the region where the account was created.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "TRANSACTION_LIMIT", "description": "The card issuer has determined the payment amount is either too high or too low.\nThe API returns the error code mostly for credit cards (for example, the card reached\nthe credit limit). However, sometimes the issuer bank can indicate the error for debit\nor prepaid cards (for example, card has insufficient funds).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VOICE_FAILURE", "description": "The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAN_FAILURE", "description": "The specified card number is invalid. For example, it is of\nincorrect length or is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "EXPIRATION_FAILURE", "description": "The card expiration date is either invalid or indicates that the\ncard is expired.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_NOT_SUPPORTED", "description": "The card is not supported either in the geographic region or by\nthe [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "READER_DECLINED", "description": "The Square Card Reader declined the payment for an unknown reason.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_PIN", "description": "The card issuer declined the request because the PIN is invalid.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_PIN", "description": "The payment is missing a required PIN.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MISSING_ACCOUNT_TYPE", "description": "The payment is missing a required ACCOUNT_TYPE parameter.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_POSTAL_CODE", "description": "The postal code is incorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "INVALID_FEES", "description": "The app_fee_money on a payment is too high.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", "description": "The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "PAYMENT_LIMIT_EXCEEDED", "description": "Square declined the request because the payment amount exceeded the processing limit for this merchant.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GIFT_CARD_AVAILABLE_AMOUNT", "description": "When a Gift Card is a payment source, you can allow taking a partial payment\nby adding the `accept_partial_authorization` parameter in the request.\nHowever, taking such a partial payment does not work if your request also includes\n`tip_money`, `app_fee_money`, or both. Square declines such payments and returns\nthe `GIFT_CARD_AVAILABLE_AMOUNT` error.\nFor more information, see\n[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ACCOUNT_UNUSABLE", "description": "The account provided cannot carry out transactions.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BUYER_REFUSED_PAYMENT", "description": "Bank account rejected or was not authorized for the payment.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "DELAYED_TRANSACTION_EXPIRED", "description": "The application tried to update a delayed-capture payment that has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CANCELED", "description": "The application tried to cancel a delayed-capture payment that was already cancelled.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_CAPTURED", "description": "The application tried to capture a delayed-capture payment that was already captured.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "DELAYED_TRANSACTION_FAILED", "description": "The application tried to update a delayed-capture payment that failed.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_EXPIRED", "description": "The provided card token (nonce) has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_TOKEN_USED", "description": "The provided card token (nonce) was already used to process the payment or refund.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "AMOUNT_TOO_HIGH", "description": "The requested payment amount is too high for the provided payment source.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_INSTRUMENT_TYPE", "description": "The API request references an unsupported instrument type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REFUND_AMOUNT_INVALID", "description": "The requested refund amount exceeds the amount available to refund.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ALREADY_PENDING", "description": "The payment already has a pending refund.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE", "description": "The payment is not refundable. For example, the payment is too old to be refunded.", "error-category": "REFUND_ERROR"}, {"name": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE", "description": "The payment is not refundable because it has been disputed.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION", "description": "The payment is not refundable because the payment is approved and needs to be completed first before the refund is issued.", "error-category": "REFUND_ERROR"}, {"name": "REFUND_DECLINED", "description": "Request failed - The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "INSUFFICIENT_PERMISSIONS_FOR_REFUND", "description": "The Square account does not have the permissions to process this refund.", "error-category": "REFUND_ERROR"}, {"name": "INVALID_CARD_DATA", "description": "Generic error - the provided card data is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_USED", "description": "The provided source id was already used to create a card.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SOURCE_EXPIRED", "description": "The provided source id has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_LOYALTY_REWARD_TIER", "description": "The referenced loyalty program reward tier is not supported.\nThis could happen if the reward tier created in a first party\napplication is incompatible with the Loyalty API.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "LOCATION_MISMATCH", "description": "Generic error - the given location does not matching what is expected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "ORDER_UNPAID_NOT_RETURNABLE", "description": "The order attempting to be returned is not yet paid and cannot be returned.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "IDEMPOTENCY_KEY_REUSED", "description": "The provided idempotency key has already been used.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNEXPECTED_VALUE", "description": "General error - the value provided was unexpected.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "SANDBOX_NOT_SUPPORTED", "description": "The API request is not supported in sandbox.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_EMAIL_ADDRESS", "description": "The provided email address is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_PHONE_NUMBER", "description": "The provided phone number is invalid.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CHECKOUT_EXPIRED", "description": "The provided checkout URL has expired.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "BAD_CERTIFICATE", "description": "Bad certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "INVALID_SQUARE_VERSION_FORMAT", "description": "The provided Square-Version is incorrectly formatted.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "API_VERSION_INCOMPATIBLE", "description": "The provided Square-Version is incompatible with the requested action.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_PRESENCE_REQUIRED", "description": "The transaction requires that a card be present.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_SOURCE_TYPE", "description": "The API request references an unsupported source type.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CARD_MISMATCH", "description": "The provided card does not match what is expected.", "error-category": "REFUND_ERROR"}, {"name": "PLAID_ERROR", "description": "Generic plaid error", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_ITEM_LOGIN_REQUIRED", "description": "Plaid error - ITEM_LOGIN_REQUIRED", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "PLAID_ERROR_RATE_LIMIT", "description": "Plaid error - RATE_LIMIT", "error-category": "EXTERNAL_VENDOR_ERROR"}, {"name": "CARD_DECLINED", "description": "The card was declined.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_CVV_FAILURE", "description": "The CVV could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "VERIFY_AVS_FAILURE", "description": "The AVS could not be verified.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_CALL_ISSUER", "description": "The payment card was declined with a request\nfor the card holder to call the issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CARD_DECLINED_VERIFICATION_REQUIRED", "description": "The payment card was declined with a request\nfor additional verification.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "BAD_EXPIRATION", "description": "The card expiration date is either missing or\nincorrectly formatted.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "CHIP_INSERTION_REQUIRED", "description": "The card issuer requires that the card be read\nusing a chip reader.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "ALLOWABLE_PIN_TRIES_EXCEEDED", "description": "The card has exhausted its available pin entry\nretries set by the card issuer. Resolving the error typically requires the\ncard holder to contact the card issuer.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "RESERVATION_DECLINED", "description": "The card issuer declined the refund.", "error-category": "REFUND_ERROR"}, {"name": "UNKNOWN_BODY_PARAMETER", "description": "The body parameter is not recognized by the requested endpoint.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_FOUND", "description": "Not Found - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", "description": "Square could not find the associated Apple Pay certificate.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "METHOD_NOT_ALLOWED", "description": "Method Not Allowed - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "NOT_ACCEPTABLE", "description": "Not Acceptable - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_TIMEOUT", "description": "Request Timeout - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "CONFLICT", "description": "Conflict - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "GONE", "description": "The target resource is no longer available and this\ncondition is likely to be permanent.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "REQUEST_ENTITY_TOO_LARGE", "description": "Request Entity Too Large - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNSUPPORTED_MEDIA_TYPE", "description": "Unsupported Media Type - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "UNPROCESSABLE_ENTITY", "description": "Unprocessable Entity - a general error occurred.", "error-category": "INVALID_REQUEST_ERROR"}, {"name": "RATE_LIMITED", "description": "Rate Limited - a general error occurred.", "error-category": "RATE_LIMIT_ERROR"}, {"name": "NOT_IMPLEMENTED", "description": "Not Implemented - a general error occurred.", "error-category": "API_ERROR"}, {"name": "BAD_GATEWAY", "description": "Bad Gateway - a general error occurred.", "error-category": "API_ERROR"}, {"name": "SERVICE_UNAVAILABLE", "description": "Service Unavailable - a general error occurred.", "error-category": "API_ERROR"}, {"name": "TEMPORARY_ERROR", "description": "A temporary internal error occurred. You can safely retry your call\nusing the same idempotency key.", "error-category": "PAYMENT_METHOD_ERROR"}, {"name": "GATEWAY_TIMEOUT", "description": "Gateway Timeout - a general error occurred.", "error-category": "API_ERROR"}], "description": "Indicates the specific error that occurred during a request to a\nSquare API.", "x-release-status": "PUBLIC"}, "detail": {"type": "string", "description": "A human-readable description of the error for debugging purposes."}, "field": {"type": "string", "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."}}}, "description": "Information about errors encountered during the request.", "nullable": true}}}, "location_id": {"type": "string", "description": "The ID of the location associated with the payment.", "maxLength": 50, "readOnly": true}, "order_id": {"type": "string", "description": "The ID of the order associated with the payment.", "maxLength": 192, "readOnly": true}, "reference_id": {"type": "string", "description": "An optional ID that associates the payment with an entity in\nanother system.", "maxLength": 40, "readOnly": true}, "customer_id": {"type": "string", "description": "The ID of the customer associated with the payment. If the ID is \nnot provided in the `CreatePayment` request that was used to create the `Payment`, \nSquare may use information in the request \n(such as the billing and shipping address, email address, and payment source) \nto identify a matching customer profile in the Customer Directory. \nIf found, the profile ID is used. If a profile is not found, the \nAPI attempts to create an \n[instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). \nIf the API cannot create an \ninstant profile (either because the seller has disabled it or the \nseller\'s region prevents creating it), this field remains unset. Note that \nthis process is asynchronous and it may take some time before a \ncustomer ID is added to the payment.", "maxLength": 191, "readOnly": true}, "employee_id": {"type": "string", "description": "__Deprecated__: Use `Payment.team_member_id` instead.\n\nAn optional ID of the employee associated with taking the payment.", "maxLength": 192, "readOnly": true, "x-release-status": "DEPRECATED"}, "team_member_id": {"type": "string", "description": "An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.", "maxLength": 192, "nullable": true}, "refund_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of `refund_id`s identifying refunds for the payment.", "readOnly": true}, "risk_evaluation": {"type": "object", "description": "Represents fraud risk information for the associated payment.\n\nWhen you take a payment through Square\'s Payments API (using the `CreatePayment`\nendpoint), Square evaluates it and assigns a risk level to the payment. Sellers\ncan use this information to determine the course of action (for example,\nprovide the goods/services or refund the payment).", "x-release-status": "BETA", "required": ["status"], "properties": {"created_at": {"type": "string", "description": "The timestamp when payment risk was evaluated, in RFC 3339 format.", "readOnly": true}, "risk_level": {"type": "string", "enum": ["PENDING", "NORMAL", "MODERATE", "HIGH"], "x-enum-elements": [{"name": "PENDING", "description": "Indicates Square is still evaluating the payment."}, {"name": "NORMAL", "description": "Indicates payment risk is within the normal range."}, {"name": "MODERATE", "description": "Indicates elevated risk level associated with the payment."}, {"name": "HIGH", "description": "Indicates significantly elevated risk level with the payment."}], "x-release-status": "BETA"}}}, "terminal_checkout_id": {"type": "string", "description": "An optional ID for a Terminal checkout that is associated with the payment.", "readOnly": true, "x-release-status": "BETA"}, "buyer_email_address": {"type": "string", "description": "The buyer\'s email address.", "maxLength": 255, "readOnly": true}, "billing_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "shipping_address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "note": {"type": "string", "description": "An optional note to include when creating a payment.", "maxLength": 500, "readOnly": true}, "statement_description_identifier": {"type": "string", "description": "Additional payment information that gets added to the customer\'s card statement\nas part of the statement description.\n\nNote that the `statement_description_identifier` might get truncated on the statement description\nto fit the required information including the Square identifier (SQ *) and the name of the\nseller taking the payment.", "readOnly": true}, "capabilities": {"type": "array", "items": {"type": "string"}, "description": "Actions that can be performed on this payment:\n- `EDIT_AMOUNT_UP` - The payment amount can be edited up.\n- `EDIT_AMOUNT_DOWN` - The payment amount can be edited down.\n- `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up.\n- `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down.\n- `EDIT_DELAY_ACTION` - The delay_action can be edited.", "readOnly": true}, "receipt_number": {"type": "string", "description": "The payment\'s receipt number.\nThe field is missing if a payment is canceled.", "maxLength": 4, "readOnly": true}, "receipt_url": {"type": "string", "description": "The URL for the payment\'s receipt.\nThe field is only populated for COMPLETED payments.", "maxLength": 255, "readOnly": true}, "device_details": {"type": "object", "description": "Details about the device that took the payment.", "x-release-status": "PUBLIC", "properties": {"device_id": {"type": "string", "description": "The Square-issued ID of the device.", "maxLength": 255, "nullable": true}, "device_installation_id": {"type": "string", "description": "The Square-issued installation ID for the device.", "maxLength": 255, "nullable": true}, "device_name": {"type": "string", "description": "The name of the device set by the seller.", "maxLength": 255, "nullable": true}}}, "application_details": {"type": "object", "description": "Details about the application that took the payment.", "x-release-status": "PUBLIC", "properties": {"square_product": {"type": "string", "enum": ["APPOINTMENTS", "ECOMMERCE_API", "INVOICES", "ONLINE_STORE", "OTHER", "RESTAURANTS", "RETAIL", "SQUARE_POS", "TERMINAL_API", "VIRTUAL_TERMINAL"], "x-enum-elements": [{"name": "APPOINTMENTS", "description": ""}, {"name": "ECOMMERCE_API", "description": ""}, {"name": "INVOICES", "description": ""}, {"name": "ONLINE_STORE", "description": ""}, {"name": "OTHER", "description": ""}, {"name": "RESTAURANTS", "description": ""}, {"name": "RETAIL", "description": ""}, {"name": "SQUARE_POS", "description": ""}, {"name": "TERMINAL_API", "description": ""}, {"name": "VIRTUAL_TERMINAL", "description": ""}], "description": "A list of products to return to external callers.", "x-release-status": "PUBLIC"}, "application_id": {"type": "string", "description": "The Square ID assigned to the application used to take the payment. \nApplication developers can use this information to identify payments that \ntheir application processed. \nFor example, if a developer uses a custom application to process payments, \nthis field contains the application ID from the Developer Dashboard. \nIf a seller uses a [Square App Marketplace](https://developer.squareup.com/docs/app-marketplace) \napplication to process payments, the field contains the corresponding application ID.", "nullable": true}}}, "is_offline_payment": {"type": "boolean", "description": "Whether or not this payment was taken offline.", "readOnly": true}, "offline_payment_details": {"type": "object", "description": "Details specific to offline payments.", "x-release-status": "DEPRECATED", "properties": {"client_created_at": {"type": "string", "description": "The client-side timestamp of when the offline payment was created, in RFC 3339 format.", "maxLength": 32, "readOnly": true}}}, "version_token": {"type": "string", "description": "Used for optimistic concurrency. This opaque token identifies a specific version of the\n`Payment` object.", "nullable": true}}}, "idempotency_key": {"type": "string", "description": "A unique string that identifies this `UpdatePayment` request. Keys can be any valid string\nbut must be unique for every `UpdatePayment` request.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).", "minLength": 1, "maxLength": 45}}, "example": {"idempotency_key": "956f8b13-e4ec-45d6-85e8-d1d95ef0c5de", "payment": {"amount_money": {"amount": 1000, "currency": "USD"}, "tip_money": {"amount": 100, "currency": "USD"}, "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o"}}}',  # noqa: E501
    "REFUNDPAYMENT": '{"type": "object", "description": "Describes a request to refund a payment using [RefundPayment](api-endpoint:Refunds-RefundPayment).", "x-release-status": "PUBLIC", "required": ["idempotency_key", "amount_money"], "properties": {"idempotency_key": {"type": "string", "description": " A unique string that identifies this `RefundPayment` request. The key can be any valid string\nbut must be unique for every `RefundPayment` request.\n\nKeys are limited to a max of 45 characters - however, the number of allowed characters might be\nless than 45, if multi-byte characters are used.\n\nFor more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).", "minLength": 1}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "payment_id": {"type": "string", "description": "The unique ID of the payment being refunded.\nRequired when unlinked=false, otherwise must not be set.", "nullable": true}, "destination_id": {"type": "string", "description": "The ID indicating where funds will be refunded to. Required for unlinked refunds. For more\ninformation, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds).\n\nFor refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds\nwill be returned to the original payment source. The field may be specified in order to request\na cross-method refund to a gift card. For more information,\nsee [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards).", "nullable": true}, "unlinked": {"type": "boolean", "description": "Indicates that the refund is not linked to a Square payment.\nIf set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not\nbe provided.", "nullable": true}, "location_id": {"type": "string", "description": "The location ID associated with the unlinked refund.\nRequired for requests specifying `unlinked=true`.\nOtherwise, if included when `unlinked=false`, will throw an error.", "maxLength": 50, "nullable": true}, "customer_id": {"type": "string", "description": "The [Customer](entity:Customer) ID of the customer associated with the refund.\nThis is required if the `destination_id` refers to a card on file created using the Cards\nAPI. Only allowed when `unlinked=true`.", "nullable": true}, "reason": {"type": "string", "description": "A description of the reason for the refund.", "maxLength": 192, "nullable": true}, "payment_version_token": {"type": "string", "description": " Used for optimistic concurrency. This opaque token identifies the current `Payment`\nversion that the caller expects. If the server has a different version of the Payment,\nthe update fails and a response with a VERSION_MISMATCH error is returned.\nIf the versions match, or the field is not provided, the refund proceeds as normal.", "x-release-status": "BETA", "nullable": true}, "team_member_id": {"type": "string", "description": "An optional [TeamMember](entity:TeamMember) ID to associate with this refund.", "maxLength": 192, "nullable": true}, "cash_details": {"type": "object", "description": "Stores details about a cash refund. Contains only non-confidential information.", "x-release-status": "PUBLIC", "required": ["seller_supplied_money"], "properties": {"seller_supplied_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "change_back_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}, "external_details": {"type": "object", "description": "Stores details about an external refund. Contains only non-confidential information.", "x-release-status": "PUBLIC", "required": ["type", "source"], "properties": {"type": {"type": "string", "description": "The type of external refund the seller paid to the buyer. It can be one of the\nfollowing:\n- CHECK - Refunded using a physical check.\n- BANK_TRANSFER - Refunded using external bank transfer.\n- OTHER\\_GIFT\\_CARD - Refunded using a non-Square gift card.\n- CRYPTO - Refunded using a crypto currency.\n- SQUARE_CASH - Refunded using Square Cash App.\n- SOCIAL - Refunded using peer-to-peer payment applications.\n- EXTERNAL - A third-party application gathered this refund outside of Square.\n- EMONEY - Refunded using an E-money provider.\n- CARD - A credit or debit card that Square does not support.\n- STORED_BALANCE - Use for house accounts, store credit, and so forth.\n- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals\n- OTHER - A type not listed here.", "maxLength": 50}, "source": {"type": "string", "description": "A description of the external refund source. For example,\n"Food Delivery Service".", "maxLength": 255}, "source_id": {"type": "string", "description": "An ID to associate the refund to its originating source.", "maxLength": 255, "nullable": true}}}}, "example": {"amount_money": {"amount": 1000, "currency": "USD"}, "app_fee_money": {"amount": 10, "currency": "USD"}, "idempotency_key": "9b7f2dcf-49da-4411-b23e-a2d6af21333a", "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY", "reason": "Example"}}',  # noqa: E501
    "CREATECUSTOMERSUBSCRIPTION": '{"type": "object", "description": "Defines input parameters in a request to the \n[CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.", "x-release-status": "PUBLIC", "required": ["location_id", "customer_id"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateSubscription` request.\nIf you do not provide a unique string (or provide an empty string as the value),\nthe endpoint treats each request as independent.\n\nFor more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."}, "location_id": {"type": "string", "description": "The ID of the location the subscription is associated with.", "minLength": 1}, "plan_variation_id": {"type": "string", "description": "The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API."}, "customer_id": {"type": "string", "description": "The ID of the [customer](entity:Customer) subscribing to the subscription plan variation.", "minLength": 1}, "start_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date to start the subscription. \nIf it is unspecified, the subscription starts immediately."}, "canceled_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation. \n\nThis date overrides the cancellation date set in the plan variation configuration.\nIf the cancellation date is earlier than the end date of a subscription cycle, the subscription stops\nat the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle. \n\nWhen the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date`\noccurs before the subscription plan completes, the specified `canceled_date` sets the date when the subscription\nstops through the end of the last cycle."}, "tax_percentage": {"type": "string", "description": "The tax to add when billing the subscription.\nThe percentage is expressed in decimal form, using a `\'.\'` as the decimal\nseparator and without a `\'%\'` sign. For example, a value of 7.5\ncorresponds to 7.5%.", "maxLength": 10}, "price_override_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "card_id": {"type": "string", "description": "The ID of the [subscriber\'s](entity:Customer) [card](entity:Card) to charge.\nIf it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription."}, "timezone": {"type": "string", "description": "The timezone that is used in date calculations for the subscription. If unset, defaults to\nthe location timezone. If a timezone is not configured for the location, defaults to "America/New_York".\nFormat: the IANA Timezone Database identifier for the location timezone. For\na list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)."}, "source": {"type": "object", "description": "The origination details of the subscription.", "x-release-status": "BETA", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that\na subscription originates. If unset, the name defaults to the name\nof the application that created the subscription.", "maxLength": 255, "nullable": true}}}, "monthly_billing_anchor_date": {"type": "integer", "description": "The day-of-the-month to change the billing date to.", "minimum": 1, "maximum": 31, "x-release-status": "BETA"}, "phases": {"type": "array", "items": {"type": "object", "description": "Represents a phase, which can override subscription phases as defined by plan_id", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "id of subscription phase", "nullable": true}, "ordinal": {"type": "integer", "description": "index of phase in total subscription plan", "format": "int64", "nullable": true}, "order_template_id": {"type": "string", "description": "id of order to be used in billing", "nullable": true}, "plan_phase_uid": {"type": "string", "description": "the uid from the plan\'s phase in catalog", "nullable": true}}}, "description": "array of phases for this subscription"}}, "example": {"card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", "location_id": "S8GWD5R9QB376", "phases": [{"order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY", "ordinal": 0}], "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H", "source": {"name": "My Application"}, "start_date": "2023-06-20", "timezone": "America/Los_Angeles"}}',  # noqa: E501
    "UPDATESUBSCRIPTION": '{"type": "object", "description": "Defines input parameters in a request to the \n[UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.", "x-release-status": "PUBLIC", "properties": {"subscription": {"type": "object", "description": "Represents a subscription purchased by a customer.\n\nFor more information, see\n[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions).", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The Square-assigned ID of the subscription.", "maxLength": 255, "readOnly": true}, "location_id": {"type": "string", "description": "The ID of the location associated with the subscription.", "readOnly": true}, "plan_variation_id": {"type": "string", "description": "The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation).", "readOnly": true}, "customer_id": {"type": "string", "description": "The ID of the subscribing [customer](entity:Customer) profile.", "readOnly": true}, "start_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription.", "readOnly": true}, "canceled_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription, \nwhen the subscription status changes to `CANCELED` and the subscription billing stops.\n\nIf this field is not set, the subscription ends according its subscription plan.\n\nThis field cannot be updated, other than being cleared.", "nullable": true}, "charged_through_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the\nsubscription.\n\nAfter the invoice is sent for a given billing period,\nthis date will be the last day of the billing period.\nFor example,\nsuppose for the month of May a subscriber gets an invoice\n(or charged the card) on May 1. For the monthly billing scenario,\nthis date is then set to May 31.", "readOnly": true}, "status": {"type": "string", "enum": ["PENDING", "ACTIVE", "CANCELED", "DEACTIVATED", "PAUSED", "COMPLETED"], "x-enum-elements": [{"name": "PENDING", "description": "The subscription is pending to start in the future."}, {"name": "ACTIVE", "description": "The subscription is active."}, {"name": "CANCELED", "description": "The subscription is canceled."}, {"name": "DEACTIVATED", "description": "The subscription is deactivated."}, {"name": "PAUSED", "description": "The subscription is paused."}, {"name": "COMPLETED", "description": "The subscription has completed all of its phases."}], "description": "Supported subscription statuses.", "x-release-status": "PUBLIC"}, "tax_percentage": {"type": "string", "description": "The tax amount applied when billing the subscription. The\npercentage is expressed in decimal form, using a `\'.\'` as the decimal\nseparator and without a `\'%\'` sign. For example, a value of `7.5`\ncorresponds to 7.5%.", "nullable": true}, "invoice_ids": {"type": "array", "items": {"type": "string"}, "description": "The IDs of the [invoices](entity:Invoice) created for the\nsubscription, listed in order when the invoices were created\n(newest invoices appear first).", "readOnly": true}, "price_override_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "version": {"type": "integer", "description": "The version of the object. When updating an object, the version\nsupplied must match the version in the database, otherwise the write will\nbe rejected as conflicting.", "format": "int64"}, "created_at": {"type": "string", "description": "The timestamp when the subscription was created, in RFC 3339 format.", "readOnly": true}, "card_id": {"type": "string", "description": "The ID of the [subscriber\'s](entity:Customer) [card](entity:Card)\nused to charge for the subscription.", "nullable": true}, "timezone": {"type": "string", "description": "Timezone that will be used in date calculations for the subscription.\nDefaults to the timezone of the location based on `location_id`.\nFormat: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`).", "readOnly": true}, "source": {"type": "object", "description": "The origination details of the subscription.", "x-release-status": "BETA", "properties": {"name": {"type": "string", "description": "The name used to identify the place (physical or digital) that\na subscription originates. If unset, the name defaults to the name\nof the application that created the subscription.", "maxLength": 255, "nullable": true}}}, "actions": {"type": "array", "items": {"type": "object", "description": "Represents an action as a pending change to a subscription.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "The ID of an action scoped to a subscription."}, "type": {"type": "string", "enum": ["CANCEL", "PAUSE", "RESUME", "SWAP_PLAN", "CHANGE_BILLING_ANCHOR_DATE", "COMPLETE"], "x-enum-elements": [{"name": "CANCEL", "description": "The action to execute a scheduled cancellation of a subscription."}, {"name": "PAUSE", "description": "The action to execute a scheduled pause of a subscription."}, {"name": "RESUME", "description": "The action to execute a scheduled resumption of a subscription."}, {"name": "SWAP_PLAN", "description": "The action to execute a scheduled swap of a subscription plan in a subscription."}, {"name": "CHANGE_BILLING_ANCHOR_DATE", "description": "A billing anchor date change action."}, {"name": "COMPLETE", "description": "The action marking when a subscription completes a fixed number of phases."}], "description": "Supported types of an action as a pending change to a subscription.", "x-release-status": "BETA"}, "effective_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date when the action occurs on the subscription.", "nullable": true}, "monthly_billing_anchor_date": {"type": "integer", "description": "The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action.", "nullable": true}, "phases": {"type": "array", "items": {"type": "object", "description": "Represents a phase, which can override subscription phases as defined by plan_id", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "id of subscription phase", "nullable": true}, "ordinal": {"type": "integer", "description": "index of phase in total subscription plan", "format": "int64", "nullable": true}, "order_template_id": {"type": "string", "description": "id of order to be used in billing", "nullable": true}, "plan_phase_uid": {"type": "string", "description": "the uid from the plan\'s phase in catalog", "nullable": true}}}, "description": "A list of Phases, to pass phase-specific information used in the swap.", "nullable": true}, "new_plan_variation_id": {"type": "string", "description": "The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action.", "nullable": true}}}, "description": "The list of scheduled actions on this subscription. It is set only in the response from  \n[RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) with the query parameter\nof `include=actions` or from \n[SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) with the input parameter \nof `include:["actions"]`.", "x-release-status": "BETA", "nullable": true}, "monthly_billing_anchor_date": {"type": "integer", "description": "The day of the month on which the subscription will issue invoices and publish orders.", "readOnly": true, "x-release-status": "BETA"}, "phases": {"type": "array", "items": {"type": "object", "description": "Represents a phase, which can override subscription phases as defined by plan_id", "x-release-status": "PUBLIC", "properties": {"uid": {"type": "string", "description": "id of subscription phase", "nullable": true}, "ordinal": {"type": "integer", "description": "index of phase in total subscription plan", "format": "int64", "nullable": true}, "order_template_id": {"type": "string", "description": "id of order to be used in billing", "nullable": true}, "plan_phase_uid": {"type": "string", "description": "the uid from the plan\'s phase in catalog", "nullable": true}}}, "description": "array of phases for this subscription", "readOnly": true}, "completed_date": {"type": "string", "description": "The `YYYY-MM-DD`-formatted date when the subscription enters a terminal state.", "x-release-status": "BETA", "nullable": true}}}}, "example": {"subscription": {"canceled_date": null, "card_id": "{NEW CARD ID}"}}}',  # noqa: E501
    "SWAPSUBSCRIPTIONPLAN": '{"type": "object", "description": "Defines input parameters in a call to the\n[SwapPlan](api-endpoint:Subscriptions-SwapPlan) endpoint.", "x-release-status": "BETA", "properties": {"new_plan_variation_id": {"type": "string", "description": "The ID of the new subscription plan variation.\n\nThis field is required.", "nullable": true}, "phases": {"type": "array", "items": {"type": "object", "description": "Represents the arguments used to construct a new phase.", "x-release-status": "PUBLIC", "required": ["ordinal"], "properties": {"ordinal": {"type": "integer", "description": "index of phase in total subscription plan", "format": "int64"}, "order_template_id": {"type": "string", "description": "id of order to be used in billing", "nullable": true}}}, "description": "A list of PhaseInputs, to pass phase-specific information used in the swap.", "nullable": true}}, "example": {"new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7", "phases": [{"order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY", "ordinal": 0}]}}',  # noqa: E501
    "CREATETEAMMEMBER": '{"type": "object", "description": "Represents a create request for a `TeamMember` object.", "x-release-status": "PUBLIC", "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateTeamMember` request.\nKeys can be any valid string, but must be unique for every request.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\n\nThe minimum length is 1 and the maximum length is 45."}, "team_member": {"type": "object", "description": "A record representing an individual team member for a business.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The unique ID for the team member.", "readOnly": true}, "reference_id": {"type": "string", "description": "A second ID used to associate the team member with an entity in another system.", "nullable": true}, "is_owner": {"type": "boolean", "description": "Whether the team member is the owner of the Square account.", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "The team member can sign in to Point of Sale and the Seller Dashboard."}, {"name": "INACTIVE", "description": "The team member can no longer sign in to Point of Sale or the Seller Dashboard,\nbut the team member\'s sales reports remain available."}], "description": "Enumerates the possible statuses the team member can have within a business.", "x-release-status": "PUBLIC"}, "given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the team member.", "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the team member.", "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the team member. After accepting the invitation\nfrom Square, only the team member can change this value.", "nullable": true}, "phone_number": {"type": "string", "description": "The team member\'s phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format.", "readOnly": true}, "assigned_locations": {"type": "object", "description": "An object that represents a team member\'s assignment to locations.", "x-release-status": "PUBLIC", "properties": {"assignment_type": {"type": "string", "enum": ["ALL_CURRENT_AND_FUTURE_LOCATIONS", "EXPLICIT_LOCATIONS"], "x-enum-elements": [{"name": "ALL_CURRENT_AND_FUTURE_LOCATIONS", "description": "The team member is assigned to all current and future locations. The `location_ids` field\nis empty if the team member has this assignment type."}, {"name": "EXPLICIT_LOCATIONS", "description": "The team member is assigned to an explicit subset of locations. The `location_ids` field\nis the list of locations that the team member is assigned to."}], "description": "Enumerates the possible assignment types that the team member can have.", "x-release-status": "PUBLIC"}, "location_ids": {"type": "array", "items": {"type": "string"}, "description": "The explicit locations that the team member is assigned to.", "nullable": true}}}, "wage_setting": {"type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", "x-release-status": "PUBLIC", "properties": {"team_member_id": {"type": "string", "description": "The ID of the team member associated with the wage setting.", "nullable": true}, "job_assignments": {"type": "array", "items": {"type": "object", "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member\'s [wage setting](entity:WageSetting).", "x-release-status": "PUBLIC", "required": ["pay_type"], "properties": {"job_title": {"type": "string", "description": "The title of the job.", "nullable": true}, "pay_type": {"type": "string", "enum": ["NONE", "HOURLY", "SALARY"], "x-enum-elements": [{"name": "NONE", "description": "The job does not have a defined pay type."}, {"name": "HOURLY", "description": "The job pays an hourly rate."}, {"name": "SALARY", "description": "The job pays an annual salary."}], "description": "Enumerates the possible pay types that a job can be assigned.", "x-release-status": "PUBLIC"}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "annual_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "weekly_hours": {"type": "integer", "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job).", "x-release-status": "BETA", "nullable": true}}}, "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member\'s primary job.", "nullable": true}, "is_overtime_exempt": {"type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller\'s country.", "nullable": true}, "version": {"type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)."}, "created_at": {"type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", "readOnly": true}}}}}}, "example": {"idempotency_key": "idempotency-key-0", "team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "phone_number": "+14159283333", "reference_id": "reference_id_1", "status": "ACTIVE", "wage_setting": {"is_overtime_exempt": true, "job_assignments": [{"annual_rate": {"amount": 3000000, "currency": "USD"}, "job_id": "FjS8x95cqHiMenw4f1NAUH4P", "pay_type": "SALARY", "weekly_hours": 40}, {"hourly_rate": {"amount": 2000, "currency": "USD"}, "job_id": "VDNpRv8da51NU8qZFC5zDWpF", "pay_type": "HOURLY"}]}}}}',  # noqa: E501
    "BULKCREATETEAMMEMBERS": '{"type": "object", "description": "Represents a bulk create request for `TeamMember` objects.", "x-release-status": "PUBLIC", "required": ["team_members"], "properties": {"team_members": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents a create request for a `TeamMember` object.", "x-release-status": "PUBLIC", "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateTeamMember` request.\nKeys can be any valid string, but must be unique for every request.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\n\nThe minimum length is 1 and the maximum length is 45."}, "team_member": {"type": "object", "description": "A record representing an individual team member for a business.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The unique ID for the team member.", "readOnly": true}, "reference_id": {"type": "string", "description": "A second ID used to associate the team member with an entity in another system.", "nullable": true}, "is_owner": {"type": "boolean", "description": "Whether the team member is the owner of the Square account.", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "The team member can sign in to Point of Sale and the Seller Dashboard."}, {"name": "INACTIVE", "description": "The team member can no longer sign in to Point of Sale or the Seller Dashboard,\nbut the team member\'s sales reports remain available."}], "description": "Enumerates the possible statuses the team member can have within a business.", "x-release-status": "PUBLIC"}, "given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the team member.", "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the team member.", "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the team member. After accepting the invitation\nfrom Square, only the team member can change this value.", "nullable": true}, "phone_number": {"type": "string", "description": "The team member\'s phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format.", "readOnly": true}, "assigned_locations": {"type": "object", "description": "An object that represents a team member\'s assignment to locations.", "x-release-status": "PUBLIC", "properties": {"assignment_type": {"type": "string", "enum": ["ALL_CURRENT_AND_FUTURE_LOCATIONS", "EXPLICIT_LOCATIONS"], "x-enum-elements": [{"name": "ALL_CURRENT_AND_FUTURE_LOCATIONS", "description": "The team member is assigned to all current and future locations. The `location_ids` field\nis empty if the team member has this assignment type."}, {"name": "EXPLICIT_LOCATIONS", "description": "The team member is assigned to an explicit subset of locations. The `location_ids` field\nis the list of locations that the team member is assigned to."}], "description": "Enumerates the possible assignment types that the team member can have.", "x-release-status": "PUBLIC"}, "location_ids": {"type": "array", "items": {"type": "string"}, "description": "The explicit locations that the team member is assigned to.", "nullable": true}}}, "wage_setting": {"type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", "x-release-status": "PUBLIC", "properties": {"team_member_id": {"type": "string", "description": "The ID of the team member associated with the wage setting.", "nullable": true}, "job_assignments": {"type": "array", "items": {"type": "object", "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member\'s [wage setting](entity:WageSetting).", "x-release-status": "PUBLIC", "required": ["pay_type"], "properties": {"job_title": {"type": "string", "description": "The title of the job.", "nullable": true}, "pay_type": {"type": "string", "enum": ["NONE", "HOURLY", "SALARY"], "x-enum-elements": [{"name": "NONE", "description": "The job does not have a defined pay type."}, {"name": "HOURLY", "description": "The job pays an hourly rate."}, {"name": "SALARY", "description": "The job pays an annual salary."}], "description": "Enumerates the possible pay types that a job can be assigned.", "x-release-status": "PUBLIC"}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "annual_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "weekly_hours": {"type": "integer", "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job).", "x-release-status": "BETA", "nullable": true}}}, "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member\'s primary job.", "nullable": true}, "is_overtime_exempt": {"type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller\'s country.", "nullable": true}, "version": {"type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)."}, "created_at": {"type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", "readOnly": true}}}}}}, "example": {"idempotency_key": "idempotency-key-0", "team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "phone_number": "+14159283333", "reference_id": "reference_id_1", "status": "ACTIVE", "wage_setting": {"is_overtime_exempt": true, "job_assignments": [{"annual_rate": {"amount": 3000000, "currency": "USD"}, "job_id": "FjS8x95cqHiMenw4f1NAUH4P", "pay_type": "SALARY", "weekly_hours": 40}, {"hourly_rate": {"amount": 2000, "currency": "USD"}, "job_id": "VDNpRv8da51NU8qZFC5zDWpF", "pay_type": "HOURLY"}]}}}}, "description": "The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`.\nThe maximum number of create objects is 25.\n\nIf you include a team member\'s `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs,\ncall [ListJobs](api-endpoint:Team-ListJobs)."}}, "example": {"team_members": {"idempotency-key-1": {"team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "phone_number": "+14159283333", "reference_id": "reference_id_1"}}, "idempotency-key-2": {"team_member": {"assigned_locations": {"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"}, "email_address": "jane_smith@gmail.com", "family_name": "Smith", "given_name": "Jane", "phone_number": "+14159223334", "reference_id": "reference_id_2"}}}}}',  # noqa: E501
    "BULKUPDATETEAMMEMBERS": '{"type": "object", "description": "Represents a bulk update request for `TeamMember` objects.", "x-release-status": "PUBLIC", "required": ["team_members"], "properties": {"team_members": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an update request for a `TeamMember` object.", "x-release-status": "PUBLIC", "properties": {"team_member": {"type": "object", "description": "A record representing an individual team member for a business.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The unique ID for the team member.", "readOnly": true}, "reference_id": {"type": "string", "description": "A second ID used to associate the team member with an entity in another system.", "nullable": true}, "is_owner": {"type": "boolean", "description": "Whether the team member is the owner of the Square account.", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "The team member can sign in to Point of Sale and the Seller Dashboard."}, {"name": "INACTIVE", "description": "The team member can no longer sign in to Point of Sale or the Seller Dashboard,\nbut the team member\'s sales reports remain available."}], "description": "Enumerates the possible statuses the team member can have within a business.", "x-release-status": "PUBLIC"}, "given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the team member.", "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the team member.", "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the team member. After accepting the invitation\nfrom Square, only the team member can change this value.", "nullable": true}, "phone_number": {"type": "string", "description": "The team member\'s phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format.", "readOnly": true}, "assigned_locations": {"type": "object", "description": "An object that represents a team member\'s assignment to locations.", "x-release-status": "PUBLIC", "properties": {"assignment_type": {"type": "string", "enum": ["ALL_CURRENT_AND_FUTURE_LOCATIONS", "EXPLICIT_LOCATIONS"], "x-enum-elements": [{"name": "ALL_CURRENT_AND_FUTURE_LOCATIONS", "description": "The team member is assigned to all current and future locations. The `location_ids` field\nis empty if the team member has this assignment type."}, {"name": "EXPLICIT_LOCATIONS", "description": "The team member is assigned to an explicit subset of locations. The `location_ids` field\nis the list of locations that the team member is assigned to."}], "description": "Enumerates the possible assignment types that the team member can have.", "x-release-status": "PUBLIC"}, "location_ids": {"type": "array", "items": {"type": "string"}, "description": "The explicit locations that the team member is assigned to.", "nullable": true}}}, "wage_setting": {"type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", "x-release-status": "PUBLIC", "properties": {"team_member_id": {"type": "string", "description": "The ID of the team member associated with the wage setting.", "nullable": true}, "job_assignments": {"type": "array", "items": {"type": "object", "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member\'s [wage setting](entity:WageSetting).", "x-release-status": "PUBLIC", "required": ["pay_type"], "properties": {"job_title": {"type": "string", "description": "The title of the job.", "nullable": true}, "pay_type": {"type": "string", "enum": ["NONE", "HOURLY", "SALARY"], "x-enum-elements": [{"name": "NONE", "description": "The job does not have a defined pay type."}, {"name": "HOURLY", "description": "The job pays an hourly rate."}, {"name": "SALARY", "description": "The job pays an annual salary."}], "description": "Enumerates the possible pay types that a job can be assigned.", "x-release-status": "PUBLIC"}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "annual_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "weekly_hours": {"type": "integer", "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job).", "x-release-status": "BETA", "nullable": true}}}, "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member\'s primary job.", "nullable": true}, "is_overtime_exempt": {"type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller\'s country.", "nullable": true}, "version": {"type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)."}, "created_at": {"type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", "readOnly": true}}}}}}, "example": {"team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "phone_number": "+14159283333", "reference_id": "reference_id_1", "status": "ACTIVE", "wage_setting": {"is_overtime_exempt": true, "job_assignments": [{"annual_rate": {"amount": 3000000, "currency": "USD"}, "job_id": "FjS8x95cqHiMenw4f1NAUH4P", "pay_type": "SALARY", "weekly_hours": 40}, {"hourly_rate": {"amount": 1200, "currency": "USD"}, "job_id": "VDNpRv8da51NU8qZFC5zDWpF", "pay_type": "HOURLY"}]}}}}, "description": "The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`.\nThe maximum number of update objects is 25.\n\nFor each team member, include the fields to add, change, or clear. Fields can be cleared using a null value.\nTo update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed,\ncall [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values."}}, "example": {"team_members": {"AFMwA08kR-MIF-3Vs0OE": {"team_member": {"assigned_locations": {"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"}, "email_address": "jane_smith@gmail.com", "family_name": "Smith", "given_name": "Jane", "is_owner": false, "phone_number": "+14159223334", "reference_id": "reference_id_2", "status": "ACTIVE"}}, "fpgteZNMaf0qOK-a4t6P": {"team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "is_owner": false, "phone_number": "+14159283333", "reference_id": "reference_id_1", "status": "ACTIVE"}}}}}',  # noqa: E501
    "UPDATETEAMMEMBER": '{"type": "object", "description": "Represents an update request for a `TeamMember` object.", "x-release-status": "PUBLIC", "properties": {"team_member": {"type": "object", "description": "A record representing an individual team member for a business.", "x-release-status": "PUBLIC", "properties": {"id": {"type": "string", "description": "The unique ID for the team member.", "readOnly": true}, "reference_id": {"type": "string", "description": "A second ID used to associate the team member with an entity in another system.", "nullable": true}, "is_owner": {"type": "boolean", "description": "Whether the team member is the owner of the Square account.", "readOnly": true}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "The team member can sign in to Point of Sale and the Seller Dashboard."}, {"name": "INACTIVE", "description": "The team member can no longer sign in to Point of Sale or the Seller Dashboard,\nbut the team member\'s sales reports remain available."}], "description": "Enumerates the possible statuses the team member can have within a business.", "x-release-status": "PUBLIC"}, "given_name": {"type": "string", "description": "The given name (that is, the first name) associated with the team member.", "nullable": true}, "family_name": {"type": "string", "description": "The family name (that is, the last name) associated with the team member.", "nullable": true}, "email_address": {"type": "string", "description": "The email address associated with the team member. After accepting the invitation\nfrom Square, only the team member can change this value.", "nullable": true}, "phone_number": {"type": "string", "description": "The team member\'s phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR", "nullable": true}, "created_at": {"type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format.", "readOnly": true}, "assigned_locations": {"type": "object", "description": "An object that represents a team member\'s assignment to locations.", "x-release-status": "PUBLIC", "properties": {"assignment_type": {"type": "string", "enum": ["ALL_CURRENT_AND_FUTURE_LOCATIONS", "EXPLICIT_LOCATIONS"], "x-enum-elements": [{"name": "ALL_CURRENT_AND_FUTURE_LOCATIONS", "description": "The team member is assigned to all current and future locations. The `location_ids` field\nis empty if the team member has this assignment type."}, {"name": "EXPLICIT_LOCATIONS", "description": "The team member is assigned to an explicit subset of locations. The `location_ids` field\nis the list of locations that the team member is assigned to."}], "description": "Enumerates the possible assignment types that the team member can have.", "x-release-status": "PUBLIC"}, "location_ids": {"type": "array", "items": {"type": "string"}, "description": "The explicit locations that the team member is assigned to.", "nullable": true}}}, "wage_setting": {"type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", "x-release-status": "PUBLIC", "properties": {"team_member_id": {"type": "string", "description": "The ID of the team member associated with the wage setting.", "nullable": true}, "job_assignments": {"type": "array", "items": {"type": "object", "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member\'s [wage setting](entity:WageSetting).", "x-release-status": "PUBLIC", "required": ["pay_type"], "properties": {"job_title": {"type": "string", "description": "The title of the job.", "nullable": true}, "pay_type": {"type": "string", "enum": ["NONE", "HOURLY", "SALARY"], "x-enum-elements": [{"name": "NONE", "description": "The job does not have a defined pay type."}, {"name": "HOURLY", "description": "The job pays an hourly rate."}, {"name": "SALARY", "description": "The job pays an annual salary."}], "description": "Enumerates the possible pay types that a job can be assigned.", "x-release-status": "PUBLIC"}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "annual_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "weekly_hours": {"type": "integer", "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job).", "x-release-status": "BETA", "nullable": true}}}, "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member\'s primary job.", "nullable": true}, "is_overtime_exempt": {"type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller\'s country.", "nullable": true}, "version": {"type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)."}, "created_at": {"type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", "readOnly": true}}}}}}, "example": {"team_member": {"assigned_locations": {"assignment_type": "EXPLICIT_LOCATIONS", "location_ids": ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"]}, "email_address": "joe_doe@gmail.com", "family_name": "Doe", "given_name": "Joe", "phone_number": "+14159283333", "reference_id": "reference_id_1", "status": "ACTIVE", "wage_setting": {"is_overtime_exempt": true, "job_assignments": [{"annual_rate": {"amount": 3000000, "currency": "USD"}, "job_id": "FjS8x95cqHiMenw4f1NAUH4P", "pay_type": "SALARY", "weekly_hours": 40}, {"hourly_rate": {"amount": 1200, "currency": "USD"}, "job_id": "VDNpRv8da51NU8qZFC5zDWpF", "pay_type": "HOURLY"}]}}}}',  # noqa: E501
    "UPDATEWAGESETTING": '{"type": "object", "description": "Represents an update request for the `WageSetting` object describing a `TeamMember`.", "x-release-status": "PUBLIC", "required": ["wage_setting"], "properties": {"wage_setting": {"type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation\nfor a [team member](entity:TeamMember).", "x-release-status": "PUBLIC", "properties": {"team_member_id": {"type": "string", "description": "The ID of the team member associated with the wage setting.", "nullable": true}, "job_assignments": {"type": "array", "items": {"type": "object", "description": "Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team\nmember earns for the job. Job assignments are listed in the team member\'s [wage setting](entity:WageSetting).", "x-release-status": "PUBLIC", "required": ["pay_type"], "properties": {"job_title": {"type": "string", "description": "The title of the job.", "nullable": true}, "pay_type": {"type": "string", "enum": ["NONE", "HOURLY", "SALARY"], "x-enum-elements": [{"name": "NONE", "description": "The job does not have a defined pay type."}, {"name": "HOURLY", "description": "The job pays an hourly rate."}, {"name": "SALARY", "description": "The job pays an annual salary."}], "description": "Enumerates the possible pay types that a job can be assigned.", "x-release-status": "PUBLIC"}, "hourly_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "annual_rate": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "weekly_hours": {"type": "integer", "description": "The planned hours per week for the job. Set if the job `PayType` is `SALARY`.", "nullable": true}, "job_id": {"type": "string", "description": "The ID of the [job](entity:Job).", "x-release-status": "BETA", "nullable": true}}}, "description": "**Required** The ordered list of jobs that the team member is assigned to.\nThe first job assignment is considered the team member\'s primary job.", "nullable": true}, "is_overtime_exempt": {"type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller\'s country.", "nullable": true}, "version": {"type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version\nprovided does not match the server version at the time of the request. If not provided,\nSquare executes a blind write, potentially overwriting data from another write. For more information,\nsee [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)."}, "created_at": {"type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format.", "readOnly": true}, "updated_at": {"type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format.", "readOnly": true}}}}, "example": {"wage_setting": {"is_overtime_exempt": true, "job_assignments": [{"annual_rate": {"amount": 3000000, "currency": "USD"}, "job_title": "Manager", "pay_type": "SALARY", "weekly_hours": 40}, {"hourly_rate": {"amount": 2000, "currency": "USD"}, "job_title": "Cashier", "pay_type": "HOURLY"}]}}}',  # noqa: E501
    "CREATETERMINALACTION": '{"type": "object", "x-release-status": "BETA", "required": ["idempotency_key", "action"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateAction` request. Keys can be any valid string\nbut must be unique for every `CreateAction` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more\ninformation.", "minLength": 1, "maxLength": 64}, "action": {"type": "object", "description": "Represents an action processed by the Square Terminal.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique ID for this `TerminalAction`.", "minLength": 10, "maxLength": 255, "readOnly": true}, "device_id": {"type": "string", "description": "The unique Id of the device intended for this `TerminalAction`.\nThe Id can be retrieved from /v2/devices api.", "nullable": true}, "deadline_duration": {"type": "string", "description": "The duration as an RFC 3339 duration, after which the action will be automatically canceled.\nTerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason\nof `TIMED_OUT`\n\nDefault: 5 minutes from creation\n\nMaximum: 5 minutes", "nullable": true}, "status": {"type": "string", "description": "The status of the `TerminalAction`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", "readOnly": true}, "cancel_reason": {"type": "string", "enum": ["BUYER_CANCELED", "SELLER_CANCELED", "TIMED_OUT"], "x-enum-elements": [{"name": "BUYER_CANCELED", "description": "A person canceled the `TerminalCheckout` from a Square device."}, {"name": "SELLER_CANCELED", "description": "A client canceled the `TerminalCheckout` using the API."}, {"name": "TIMED_OUT", "description": "The `TerminalCheckout` timed out (see `deadline_duration` on the `TerminalCheckout`)."}], "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The time when the `TerminalAction` was created as an RFC 3339 timestamp.", "readOnly": true}, "updated_at": {"type": "string", "description": "The time when the `TerminalAction` was last updated as an RFC 3339 timestamp.", "readOnly": true}, "app_id": {"type": "string", "description": "The ID of the application that created the action.", "readOnly": true}, "location_id": {"type": "string", "description": "The location id the action is attached to, if a link can be made.", "maxLength": 64, "readOnly": true, "x-release-status": "PUBLIC"}, "type": {"type": "string", "enum": ["QR_CODE", "PING", "SAVE_CARD", "SIGNATURE", "CONFIRMATION", "RECEIPT", "DATA_COLLECTION", "SELECT"], "x-enum-elements": [{"name": "QR_CODE", "description": "The action represents a request to display a QR code. Details are contained in\nthe `qr_code_options` object."}, {"name": "PING", "description": "The action represents a request to check if the specific device is\nonline or currently active with the merchant in question. Does not require an action options value."}, {"name": "SAVE_CARD", "description": "Represents a request to save a card for future card-on-file use. Details are contained\nin the `save_card_options` object."}, {"name": "SIGNATURE", "description": "The action represents a request to capture a buyer\'s signature. Details are contained\nin the `signature_options` object."}, {"name": "CONFIRMATION", "description": "The action represents a request to collect a buyer\'s confirmation decision to the\ndisplayed terms. Details are contained in the `confirmation_options` object."}, {"name": "RECEIPT", "description": "The action represents a request to display the receipt screen options. Details are\ncontained in the `receipt_options` object."}, {"name": "DATA_COLLECTION", "description": "The action represents a request to collect a buyer\'s text data. Details\nare contained in the `data_collection_options` object."}, {"name": "SELECT", "description": "The action represents a request to allow the buyer to select from provided options.\nDetails are contained in the `select_options` object."}], "description": "Describes the type of this unit and indicates which field contains the unit information. This is an \u2018open\u2019 enum.", "x-release-status": "BETA"}, "qr_code_options": {"type": "object", "description": "Fields to describe the action that displays QR-Codes.", "x-release-status": "BETA", "required": ["title", "body", "barcode_contents"], "properties": {"title": {"type": "string", "description": "The title text to display in the QR code flow on the Terminal.", "minLength": 1, "maxLength": 250}, "body": {"type": "string", "description": "The body text to display in the QR code flow on the Terminal.", "minLength": 1, "maxLength": 10000}, "barcode_contents": {"type": "string", "description": "The text representation of the data to show in the QR code\nas UTF8-encoded data.", "minLength": 1, "maxLength": 1024}}}, "save_card_options": {"type": "object", "description": "Describes save-card action fields.", "x-release-status": "BETA", "required": ["customer_id"], "properties": {"customer_id": {"type": "string", "description": "The square-assigned ID of the customer linked to the saved card."}, "card_id": {"type": "string", "description": "The id of the created card-on-file.", "maxLength": 64, "readOnly": true}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that can be used to associate\nthis `Card` to another entity in an external system. For example, a customer\nID generated by a third-party system.", "maxLength": 128, "nullable": true}}}, "signature_options": {"type": "object", "x-release-status": "BETA", "required": ["title", "body"], "properties": {"title": {"type": "string", "description": "The title text to display in the signature capture flow on the Terminal.", "minLength": 1, "maxLength": 250}, "body": {"type": "string", "description": "The body text to display in the signature capture flow on the Terminal.", "minLength": 1, "maxLength": 10000}, "signature": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "properties": {"image_type": {"type": "string", "description": "The mime/type of the image data.\nUse `image/png;base64` for png.", "readOnly": true}, "data": {"type": "string", "description": "The base64 representation of the image.", "readOnly": true}}}, "description": "An image representation of the collected signature.", "readOnly": true}}}, "confirmation_options": {"type": "object", "x-release-status": "BETA", "required": ["title", "body", "agree_button_text"], "properties": {"title": {"type": "string", "description": "The title text to display in the confirmation screen flow on the Terminal.", "minLength": 1, "maxLength": 250}, "body": {"type": "string", "description": "The agreement details to display in the confirmation flow on the Terminal.", "minLength": 1, "maxLength": 10000}, "agree_button_text": {"type": "string", "description": "The button text to display indicating the customer agrees to the displayed terms.", "minLength": 1, "maxLength": 250}, "disagree_button_text": {"type": "string", "description": "The button text to display indicating the customer does not agree to the displayed terms.", "minLength": 1, "maxLength": 250, "nullable": true}, "decision": {"type": "object", "x-release-status": "BETA", "properties": {"has_agreed": {"type": "boolean", "description": "The buyer\'s decision to the displayed terms.", "readOnly": true}}}}}, "receipt_options": {"type": "object", "description": "Describes receipt action fields.", "x-release-status": "BETA", "required": ["payment_id"], "properties": {"payment_id": {"type": "string", "description": "The reference to the Square payment ID for the receipt."}, "print_only": {"type": "boolean", "description": "Instructs the device to print the receipt without displaying the receipt selection screen.\nRequires `printer_enabled` set to true.\nDefaults to false.", "nullable": true}, "is_duplicate": {"type": "boolean", "description": "Identify the receipt as a reprint rather than an original receipt.\nDefaults to false.", "nullable": true}}}, "data_collection_options": {"type": "object", "x-release-status": "BETA", "required": ["title", "body", "input_type"], "properties": {"title": {"type": "string", "description": "The title text to display in the data collection flow on the Terminal.", "minLength": 1, "maxLength": 250}, "body": {"type": "string", "description": "The body text to display under the title in the data collection screen flow on the\nTerminal.", "minLength": 1, "maxLength": 10000}, "input_type": {"type": "string", "enum": ["EMAIL", "PHONE_NUMBER"], "x-enum-elements": [{"name": "EMAIL", "description": "This value is used to represent an input text that contains a email validation on the\nclient."}, {"name": "PHONE_NUMBER", "description": "This value is used to represent an input text that contains a phone number validation on\nthe client."}], "description": "Describes the input type of the data.", "x-release-status": "BETA"}, "collected_data": {"type": "object", "x-release-status": "BETA", "properties": {"input_text": {"type": "string", "description": "The buyer\'s input text.", "readOnly": true}}}}}, "select_options": {"type": "object", "x-release-status": "BETA", "required": ["title", "body", "options"], "properties": {"title": {"type": "string", "description": "The title text to display in the select flow on the Terminal.", "minLength": 1, "maxLength": 250}, "body": {"type": "string", "description": "The body text to display in the select flow on the Terminal.", "minLength": 1, "maxLength": 10000}, "options": {"type": "array", "items": {"type": "object", "x-release-status": "BETA", "required": ["reference_id", "title"], "properties": {"reference_id": {"type": "string", "description": "The reference id for the option.", "minLength": 1, "maxLength": 40}, "title": {"type": "string", "description": "The title text that displays in the select option button.", "minLength": 1, "maxLength": 250}}}, "description": "Represents the buttons/options that should be displayed in the select flow on the Terminal."}, "selected_option": {"type": "object", "x-release-status": "BETA", "required": ["reference_id", "title"], "properties": {"reference_id": {"type": "string", "description": "The reference id for the option.", "minLength": 1, "maxLength": 40}, "title": {"type": "string", "description": "The title text that displays in the select option button.", "minLength": 1, "maxLength": 250}}}}}, "device_metadata": {"type": "object", "x-release-status": "BETA", "properties": {"battery_percentage": {"type": "string", "description": "The Terminal\u2019s remaining battery percentage, between 1-100.", "nullable": true}, "charging_state": {"type": "string", "description": "The current charging state of the Terminal.\nOptions: `CHARGING`, `NOT_CHARGING`", "nullable": true}, "location_id": {"type": "string", "description": "The ID of the Square seller business location associated with the Terminal.", "nullable": true}, "merchant_id": {"type": "string", "description": "The ID of the Square merchant account that is currently signed-in to the Terminal.", "nullable": true}, "network_connection_type": {"type": "string", "description": "The Terminal\u2019s current network connection type.\nOptions: `WIFI`, `ETHERNET`", "nullable": true}, "payment_region": {"type": "string", "description": "The country in which the Terminal is authorized to take payments.", "nullable": true}, "serial_number": {"type": "string", "description": "The unique identifier assigned to the Terminal, which can be found on the lower back\nof the device.", "nullable": true}, "os_version": {"type": "string", "description": "The current version of the Terminal\u2019s operating system.", "nullable": true}, "app_version": {"type": "string", "description": "The current version of the application running on the Terminal.", "nullable": true}, "wifi_network_name": {"type": "string", "description": "The name of the Wi-Fi network to which the Terminal is connected.", "nullable": true}, "wifi_network_strength": {"type": "string", "description": "The signal strength of the Wi-FI network connection.\nOptions: `POOR`, `FAIR`, `GOOD`, `EXCELLENT`", "nullable": true}, "ip_address": {"type": "string", "description": "The IP address of the Terminal.", "nullable": true}}}, "await_next_action": {"type": "boolean", "description": "Indicates the action will be linked to another action and requires a waiting dialog to be\ndisplayed instead of returning to the idle screen on completion of the action.\n\nOnly supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types.", "nullable": true}, "await_next_action_duration": {"type": "string", "description": "The timeout duration of the waiting dialog as an RFC 3339 duration, after which the\nwaiting dialog will no longer be displayed and the Terminal will return to the idle screen.\n\nDefault: 5 minutes from when the waiting dialog is displayed\n\nMaximum: 5 minutes", "nullable": true}}}}, "example": {"action": {"deadline_duration": "PT5M", "device_id": "{{DEVICE_ID}}", "save_card_options": {"customer_id": "{{CUSTOMER_ID}}", "reference_id": "user-id-1"}, "type": "SAVE_CARD"}, "idempotency_key": "thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e"}}',  # noqa: E501
    "CREATETERMINALCHECKOUT": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key", "checkout"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but\nmust be unique for every `CreateCheckout` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1, "maxLength": 64}, "checkout": {"type": "object", "description": "Represents a checkout processed by the Square Terminal.", "x-release-status": "PUBLIC", "required": ["amount_money", "device_options"], "properties": {"id": {"type": "string", "description": "A unique ID for this `TerminalCheckout`.", "minLength": 10, "maxLength": 255, "readOnly": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reference_id": {"type": "string", "description": "An optional user-defined reference ID that can be used to associate\nthis `TerminalCheckout` to another entity in an external system. For example, an order\nID generated by a third-party shopping cart. The ID is also associated with any payments\nused to complete the checkout.", "maxLength": 40, "nullable": true}, "note": {"type": "string", "description": "An optional note to associate with the checkout, as well as with any payments used to complete the checkout.\nNote: maximum 500 characters", "maxLength": 500, "nullable": true}, "order_id": {"type": "string", "description": "The reference to the Square order ID for the checkout request.", "nullable": true}, "payment_options": {"type": "object", "x-release-status": "PUBLIC", "properties": {"autocomplete": {"type": "boolean", "description": "Indicates whether the `Payment` objects created from this `TerminalCheckout` are\nautomatically `COMPLETED` or left in an `APPROVED` state for later modification.\n\nDefault: true", "nullable": true}, "delay_duration": {"type": "string", "description": "The duration of time after the payment\'s creation when Square automatically resolves the\npayment. This automatic resolution applies only to payments that do not reach a terminal state\n(`COMPLETED` or `CANCELED`) before the `delay_duration` time period.\n\nThis parameter should be specified as a time duration, in RFC 3339 format, with a minimum value\nof 1 minute and a maximum value of 36 hours. This feature is only supported for card payments,\nand all payments will be considered card-present.\n\nThis parameter can only be set for a delayed capture payment (`autocomplete=false`). For more\ninformation, see [Delayed Capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).\n\nDefault: "PT36H" (36 hours) from the creation time", "nullable": true}, "accept_partial_authorization": {"type": "boolean", "description": "If set to `true` and charging a Square Gift Card, a payment might be returned with\n`amount_money` equal to less than what was requested. For example, a request for $20 when charging\na Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose\nto prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card\npayment.\n\nThis parameter can only be set for a delayed capture payment (`autocomplete=false`).\n\nFor more information, see [Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards).\n\nDefault: false", "nullable": true}, "delay_action": {"type": "string", "enum": ["CANCEL", "COMPLETE"], "x-enum-elements": [{"name": "CANCEL", "description": "Indicates that the payment should be automatically canceled when the delay duration\nelapses."}, {"name": "COMPLETE", "description": "Indicates that the payment should be automatically completed when the delay duration\nelapses."}], "description": "Describes the action to be applied to a delayed capture payment when the delay_duration\nhas elapsed.", "x-release-status": "PUBLIC"}}}, "device_options": {"type": "object", "x-release-status": "PUBLIC", "required": ["device_id"], "properties": {"device_id": {"type": "string", "description": "The unique ID of the device intended for this `TerminalCheckout`.\nA list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint.\nMatch a `DeviceCode.device_id` value with `device_id` to get the associated device code."}, "skip_receipt_screen": {"type": "boolean", "description": "Instructs the device to skip the receipt screen. Defaults to false.", "nullable": true}, "collect_signature": {"type": "boolean", "description": "Indicates that signature collection is desired during checkout. Defaults to false.", "nullable": true}, "tip_settings": {"type": "object", "x-release-status": "PUBLIC", "properties": {"allow_tipping": {"type": "boolean", "description": "Indicates whether tipping is enabled for this checkout. Defaults to false.", "nullable": true}, "separate_tip_screen": {"type": "boolean", "description": "Indicates whether tip options should be presented on the screen before presenting\nthe signature screen during card payment. Defaults to false.", "nullable": true}, "custom_tip_field": {"type": "boolean", "description": "Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false.", "nullable": true}, "tip_percentages": {"type": "array", "items": {"type": "integer"}, "description": "A list of tip percentages that should be presented during the checkout flow, specified as\nup to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.", "nullable": true}, "smart_tipping": {"type": "boolean", "description": "Enables the "Smart Tip Amounts" behavior.\nExact tipping options depend on the region in which the Square seller is active.\n\nFor payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00.\n\nFor payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%.\n\nIf set to true, the `tip_percentages` settings is ignored.\nDefaults to false.\n\nTo learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app).", "nullable": true}}}, "show_itemized_cart": {"type": "boolean", "description": "Show the itemization screen prior to taking a payment. This field is only meaningful when the\ncheckout includes an order ID. Defaults to true.", "nullable": true}}}, "deadline_duration": {"type": "string", "description": "An RFC 3339 duration, after which the checkout is automatically canceled.\nA `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason\nof `TIMED_OUT`.\n\nDefault: 5 minutes from creation\n\nMaximum: 5 minutes", "x-release-status": "DEPRECATED", "nullable": true}, "status": {"type": "string", "description": "The status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`", "readOnly": true}, "cancel_reason": {"type": "string", "enum": ["BUYER_CANCELED", "SELLER_CANCELED", "TIMED_OUT"], "x-enum-elements": [{"name": "BUYER_CANCELED", "description": "A person canceled the `TerminalCheckout` from a Square device."}, {"name": "SELLER_CANCELED", "description": "A client canceled the `TerminalCheckout` using the API."}, {"name": "TIMED_OUT", "description": "The `TerminalCheckout` timed out (see `deadline_duration` on the `TerminalCheckout`)."}], "x-release-status": "PUBLIC"}, "payment_ids": {"type": "array", "items": {"type": "string"}, "description": "A list of IDs for payments created by this `TerminalCheckout`.", "readOnly": true}, "created_at": {"type": "string", "description": "The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp.", "readOnly": true}, "updated_at": {"type": "string", "description": "The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp.", "readOnly": true}, "app_id": {"type": "string", "description": "The ID of the application that created the checkout.", "readOnly": true}, "location_id": {"type": "string", "description": "The location of the device where the `TerminalCheckout` was directed.", "maxLength": 64, "readOnly": true}, "payment_type": {"type": "string", "enum": ["CARD_PRESENT", "MANUAL_CARD_ENTRY", "FELICA_ID", "FELICA_QUICPAY", "FELICA_TRANSPORTATION_GROUP", "FELICA_ALL", "PAYPAY", "QR_CODE"], "x-enum-elements": [{"name": "CARD_PRESENT", "description": "Accept credit card or debit card payments via tap, dip or swipe."}, {"name": "MANUAL_CARD_ENTRY", "description": "Launches the manual credit or debit card entry screen for the buyer to complete."}, {"name": "FELICA_ID", "description": "Launches the iD checkout screen for the buyer to complete."}, {"name": "FELICA_QUICPAY", "description": "Launches the QUICPay checkout screen for the buyer to complete."}, {"name": "FELICA_TRANSPORTATION_GROUP", "description": "Launches the Transportation Group checkout screen for the buyer to complete."}, {"name": "FELICA_ALL", "description": "Launches a checkout screen for the buyer on the Square Terminal that\nallows them to select a specific FeliCa brand or select the check balance screen."}, {"name": "PAYPAY", "description": "Replaced by `QR_CODE`."}, {"name": "QR_CODE", "description": "Launches Square\'s QR Code checkout screen for the buyer to complete.\nDisplays a single code that supports all digital wallets connected to the target\nSeller location (e.g. PayPay)"}], "x-release-status": "PUBLIC"}, "team_member_id": {"type": "string", "description": "An optional ID of the team member associated with creating the checkout.", "nullable": true}, "customer_id": {"type": "string", "description": "An optional ID of the customer associated with the checkout.", "nullable": true}, "app_fee_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "statement_description_identifier": {"type": "string", "description": "Optional additional payment information to include on the customer\'s card statement as\npart of the statement description. This can be, for example, an invoice number, ticket number,\nor short description that uniquely identifies the purchase.", "maxLength": 20, "nullable": true}, "tip_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}}}}, "example": {"checkout": {"amount_money": {"amount": 2610, "currency": "USD"}, "device_options": {"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003"}, "note": "A brief note", "reference_id": "id11572"}, "idempotency_key": "28a0c3bc-7839-11ea-bc55-0242ac130003"}}',  # noqa: E501
    "CREATETERMINALREFUND": '{"type": "object", "x-release-status": "PUBLIC", "required": ["idempotency_key"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this `CreateRefund` request. Keys can be any valid string but\nmust be unique for every `CreateRefund` request.\n\nSee [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.", "minLength": 1, "maxLength": 64}, "refund": {"type": "object", "description": "Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.", "x-release-status": "PUBLIC", "required": ["payment_id", "amount_money", "reason", "device_id"], "properties": {"id": {"type": "string", "description": "A unique ID for this `TerminalRefund`.", "minLength": 10, "maxLength": 255, "readOnly": true}, "refund_id": {"type": "string", "description": "The reference to the payment refund created by completing this `TerminalRefund`.", "readOnly": true}, "payment_id": {"type": "string", "description": "The unique ID of the payment being refunded.", "minLength": 1}, "order_id": {"type": "string", "description": "The reference to the Square order ID for the payment identified by the `payment_id`.", "readOnly": true}, "amount_money": {"type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.", "x-release-status": "PUBLIC", "properties": {"amount": {"type": "integer", "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case.", "format": "int64", "nullable": true}, "currency": {"type": "string", "enum": ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SLE", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "XUS"], "x-enum-elements": [{"name": "UNKNOWN_CURRENCY", "description": "Unknown currency"}, {"name": "AED", "description": "United Arab Emirates dirham"}, {"name": "AFN", "description": "Afghan afghani"}, {"name": "ALL", "description": "Albanian lek"}, {"name": "AMD", "description": "Armenian dram"}, {"name": "ANG", "description": "Netherlands Antillean guilder"}, {"name": "AOA", "description": "Angolan kwanza"}, {"name": "ARS", "description": "Argentine peso"}, {"name": "AUD", "description": "Australian dollar"}, {"name": "AWG", "description": "Aruban florin"}, {"name": "AZN", "description": "Azerbaijani manat"}, {"name": "BAM", "description": "Bosnia and Herzegovina convertible mark"}, {"name": "BBD", "description": "Barbados dollar"}, {"name": "BDT", "description": "Bangladeshi taka"}, {"name": "BGN", "description": "Bulgarian lev"}, {"name": "BHD", "description": "Bahraini dinar"}, {"name": "BIF", "description": "Burundian franc"}, {"name": "BMD", "description": "Bermudian dollar"}, {"name": "BND", "description": "Brunei dollar"}, {"name": "BOB", "description": "Boliviano"}, {"name": "BOV", "description": "Bolivian Mvdol"}, {"name": "BRL", "description": "Brazilian real"}, {"name": "BSD", "description": "Bahamian dollar"}, {"name": "BTN", "description": "Bhutanese ngultrum"}, {"name": "BWP", "description": "Botswana pula"}, {"name": "BYR", "description": "Belarusian ruble"}, {"name": "BZD", "description": "Belize dollar"}, {"name": "CAD", "description": "Canadian dollar"}, {"name": "CDF", "description": "Congolese franc"}, {"name": "CHE", "description": "WIR Euro"}, {"name": "CHF", "description": "Swiss franc"}, {"name": "CHW", "description": "WIR Franc"}, {"name": "CLF", "description": "Unidad de Fomento"}, {"name": "CLP", "description": "Chilean peso"}, {"name": "CNY", "description": "Chinese yuan"}, {"name": "COP", "description": "Colombian peso"}, {"name": "COU", "description": "Unidad de Valor Real"}, {"name": "CRC", "description": "Costa Rican colon"}, {"name": "CUC", "description": "Cuban convertible peso"}, {"name": "CUP", "description": "Cuban peso"}, {"name": "CVE", "description": "Cape Verdean escudo"}, {"name": "CZK", "description": "Czech koruna"}, {"name": "DJF", "description": "Djiboutian franc"}, {"name": "DKK", "description": "Danish krone"}, {"name": "DOP", "description": "Dominican peso"}, {"name": "DZD", "description": "Algerian dinar"}, {"name": "EGP", "description": "Egyptian pound"}, {"name": "ERN", "description": "Eritrean nakfa"}, {"name": "ETB", "description": "Ethiopian birr"}, {"name": "EUR", "description": "Euro"}, {"name": "FJD", "description": "Fiji dollar"}, {"name": "FKP", "description": "Falkland Islands pound"}, {"name": "GBP", "description": "Pound sterling"}, {"name": "GEL", "description": "Georgian lari"}, {"name": "GHS", "description": "Ghanaian cedi"}, {"name": "GIP", "description": "Gibraltar pound"}, {"name": "GMD", "description": "Gambian dalasi"}, {"name": "GNF", "description": "Guinean franc"}, {"name": "GTQ", "description": "Guatemalan quetzal"}, {"name": "GYD", "description": "Guyanese dollar"}, {"name": "HKD", "description": "Hong Kong dollar"}, {"name": "HNL", "description": "Honduran lempira"}, {"name": "HRK", "description": "Croatian kuna"}, {"name": "HTG", "description": "Haitian gourde"}, {"name": "HUF", "description": "Hungarian forint"}, {"name": "IDR", "description": "Indonesian rupiah"}, {"name": "ILS", "description": "Israeli new shekel"}, {"name": "INR", "description": "Indian rupee"}, {"name": "IQD", "description": "Iraqi dinar"}, {"name": "IRR", "description": "Iranian rial"}, {"name": "ISK", "description": "Icelandic kr\u00f3na"}, {"name": "JMD", "description": "Jamaican dollar"}, {"name": "JOD", "description": "Jordanian dinar"}, {"name": "JPY", "description": "Japanese yen"}, {"name": "KES", "description": "Kenyan shilling"}, {"name": "KGS", "description": "Kyrgyzstani som"}, {"name": "KHR", "description": "Cambodian riel"}, {"name": "KMF", "description": "Comoro franc"}, {"name": "KPW", "description": "North Korean won"}, {"name": "KRW", "description": "South Korean won"}, {"name": "KWD", "description": "Kuwaiti dinar"}, {"name": "KYD", "description": "Cayman Islands dollar"}, {"name": "KZT", "description": "Kazakhstani tenge"}, {"name": "LAK", "description": "Lao kip"}, {"name": "LBP", "description": "Lebanese pound"}, {"name": "LKR", "description": "Sri Lankan rupee"}, {"name": "LRD", "description": "Liberian dollar"}, {"name": "LSL", "description": "Lesotho loti"}, {"name": "LTL", "description": "Lithuanian litas"}, {"name": "LVL", "description": "Latvian lats"}, {"name": "LYD", "description": "Libyan dinar"}, {"name": "MAD", "description": "Moroccan dirham"}, {"name": "MDL", "description": "Moldovan leu"}, {"name": "MGA", "description": "Malagasy ariary"}, {"name": "MKD", "description": "Macedonian denar"}, {"name": "MMK", "description": "Myanmar kyat"}, {"name": "MNT", "description": "Mongolian t\u00f6gr\u00f6g"}, {"name": "MOP", "description": "Macanese pataca"}, {"name": "MRO", "description": "Mauritanian ouguiya"}, {"name": "MUR", "description": "Mauritian rupee"}, {"name": "MVR", "description": "Maldivian rufiyaa"}, {"name": "MWK", "description": "Malawian kwacha"}, {"name": "MXN", "description": "Mexican peso"}, {"name": "MXV", "description": "Mexican Unidad de Inversion"}, {"name": "MYR", "description": "Malaysian ringgit"}, {"name": "MZN", "description": "Mozambican metical"}, {"name": "NAD", "description": "Namibian dollar"}, {"name": "NGN", "description": "Nigerian naira"}, {"name": "NIO", "description": "Nicaraguan c\u00f3rdoba"}, {"name": "NOK", "description": "Norwegian krone"}, {"name": "NPR", "description": "Nepalese rupee"}, {"name": "NZD", "description": "New Zealand dollar"}, {"name": "OMR", "description": "Omani rial"}, {"name": "PAB", "description": "Panamanian balboa"}, {"name": "PEN", "description": "Peruvian sol"}, {"name": "PGK", "description": "Papua New Guinean kina"}, {"name": "PHP", "description": "Philippine peso"}, {"name": "PKR", "description": "Pakistani rupee"}, {"name": "PLN", "description": "Polish z\u0142oty"}, {"name": "PYG", "description": "Paraguayan guaran\u00ed"}, {"name": "QAR", "description": "Qatari riyal"}, {"name": "RON", "description": "Romanian leu"}, {"name": "RSD", "description": "Serbian dinar"}, {"name": "RUB", "description": "Russian ruble"}, {"name": "RWF", "description": "Rwandan franc"}, {"name": "SAR", "description": "Saudi riyal"}, {"name": "SBD", "description": "Solomon Islands dollar"}, {"name": "SCR", "description": "Seychelles rupee"}, {"name": "SDG", "description": "Sudanese pound"}, {"name": "SEK", "description": "Swedish krona"}, {"name": "SGD", "description": "Singapore dollar"}, {"name": "SHP", "description": "Saint Helena pound"}, {"name": "SLL", "description": "Sierra Leonean first leone"}, {"name": "SLE", "description": "Sierra Leonean second leone"}, {"name": "SOS", "description": "Somali shilling"}, {"name": "SRD", "description": "Surinamese dollar"}, {"name": "SSP", "description": "South Sudanese pound"}, {"name": "STD", "description": "S\u00e3o Tom\u00e9 and Pr\u00edncipe dobra"}, {"name": "SVC", "description": "Salvadoran col\u00f3n"}, {"name": "SYP", "description": "Syrian pound"}, {"name": "SZL", "description": "Swazi lilangeni"}, {"name": "THB", "description": "Thai baht"}, {"name": "TJS", "description": "Tajikstani somoni"}, {"name": "TMT", "description": "Turkmenistan manat"}, {"name": "TND", "description": "Tunisian dinar"}, {"name": "TOP", "description": "Tongan pa\'anga"}, {"name": "TRY", "description": "Turkish lira"}, {"name": "TTD", "description": "Trinidad and Tobago dollar"}, {"name": "TWD", "description": "New Taiwan dollar"}, {"name": "TZS", "description": "Tanzanian shilling"}, {"name": "UAH", "description": "Ukrainian hryvnia"}, {"name": "UGX", "description": "Ugandan shilling"}, {"name": "USD", "description": "United States dollar"}, {"name": "USN", "description": "United States dollar (next day)"}, {"name": "USS", "description": "United States dollar (same day)"}, {"name": "UYI", "description": "Uruguay Peso en Unidedades Indexadas"}, {"name": "UYU", "description": "Uruguyan peso"}, {"name": "UZS", "description": "Uzbekistan som"}, {"name": "VEF", "description": "Venezuelan bol\u00edvar soberano"}, {"name": "VND", "description": "Vietnamese \u0111\u1ed3ng"}, {"name": "VUV", "description": "Vanuatu vatu"}, {"name": "WST", "description": "Samoan tala"}, {"name": "XAF", "description": "CFA franc BEAC"}, {"name": "XAG", "description": "Silver"}, {"name": "XAU", "description": "Gold"}, {"name": "XBA", "description": "European Composite Unit"}, {"name": "XBB", "description": "European Monetary Unit"}, {"name": "XBC", "description": "European Unit of Account 9"}, {"name": "XBD", "description": "European Unit of Account 17"}, {"name": "XCD", "description": "East Caribbean dollar"}, {"name": "XDR", "description": "Special drawing rights (International Monetary Fund)"}, {"name": "XOF", "description": "CFA franc BCEAO"}, {"name": "XPD", "description": "Palladium"}, {"name": "XPF", "description": "CFP franc"}, {"name": "XPT", "description": "Platinum"}, {"name": "XTS", "description": "Code reserved for testing"}, {"name": "XXX", "description": "No currency"}, {"name": "YER", "description": "Yemeni rial"}, {"name": "ZAR", "description": "South African rand"}, {"name": "ZMK", "description": "Zambian kwacha"}, {"name": "ZMW", "description": "Zambian kwacha"}, {"name": "BTC", "description": "Bitcoin"}, {"name": "XUS", "description": "USD Coin"}], "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).", "x-release-status": "PUBLIC"}}}, "reason": {"type": "string", "description": "A description of the reason for the refund.", "maxLength": 192}, "device_id": {"type": "string", "description": "The unique ID of the device intended for this `TerminalRefund`.\nThe Id can be retrieved from /v2/devices api."}, "deadline_duration": {"type": "string", "description": "The RFC 3339 duration, after which the refund is automatically canceled.\nA `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason\nof `TIMED_OUT`.\n\nDefault: 5 minutes from creation.\n\nMaximum: 5 minutes", "nullable": true}, "status": {"type": "string", "description": "The status of the `TerminalRefund`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.", "readOnly": true}, "cancel_reason": {"type": "string", "enum": ["BUYER_CANCELED", "SELLER_CANCELED", "TIMED_OUT"], "x-enum-elements": [{"name": "BUYER_CANCELED", "description": "A person canceled the `TerminalCheckout` from a Square device."}, {"name": "SELLER_CANCELED", "description": "A client canceled the `TerminalCheckout` using the API."}, {"name": "TIMED_OUT", "description": "The `TerminalCheckout` timed out (see `deadline_duration` on the `TerminalCheckout`)."}], "x-release-status": "PUBLIC"}, "created_at": {"type": "string", "description": "The time when the `TerminalRefund` was created, as an RFC 3339 timestamp.", "readOnly": true}, "updated_at": {"type": "string", "description": "The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp.", "readOnly": true}, "app_id": {"type": "string", "description": "The ID of the application that created the refund.", "readOnly": true}, "location_id": {"type": "string", "description": "The location of the device where the `TerminalRefund` was directed.", "maxLength": 64, "readOnly": true}}}}, "example": {"idempotency_key": "402a640b-b26f-401f-b406-46f839590c04", "refund": {"amount_money": {"amount": 111, "currency": "CAD"}, "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291", "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY", "reason": "Returning items"}}}',  # noqa: E501
    "CREATETRANSFERORDER": '{"type": "object", "description": "Request to create a new transfer order.", "x-release-status": "BETA", "required": ["idempotency_key", "transfer_order"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this CreateTransferOrder request. Keys can be\nany valid string but must be unique for every CreateTransferOrder request.", "minLength": 1}, "transfer_order": {"type": "object", "description": "Data for creating a new transfer order to move [CatalogItemVariation](entity:CatalogItemVariation)s\nbetween [Location](entity:Location)s. Used with the [CreateTransferOrder](api-endpoint:TransferOrders-CreateTransferOrder)\nendpoint.", "x-release-status": "BETA", "required": ["source_location_id", "destination_location_id"], "properties": {"source_location_id": {"type": "string", "description": "The source [Location](entity:Location) that will send the items. Must be an active location\nin your Square account with sufficient inventory of the requested items.", "minLength": 1, "maxLength": 64}, "destination_location_id": {"type": "string", "description": "The destination [Location](entity:Location) that will receive the items. Must be an active location\nin your Square account", "minLength": 1, "maxLength": 64}, "expected_at": {"type": "string", "description": "Expected transfer date in RFC 3339 format (e.g. "2023-10-01T12:00:00Z").", "nullable": true}, "notes": {"type": "string", "description": "Optional notes about the transfer", "maxLength": 4096, "nullable": true}, "tracking_number": {"type": "string", "description": "Optional shipment tracking number", "maxLength": 64, "nullable": true}, "created_by_team_member_id": {"type": "string", "description": "ID of the [TeamMember](entity:TeamMember) creating this transfer order. Used for tracking\nand auditing purposes.", "maxLength": 64, "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Data for creating a new transfer order line item. Each line item specifies a \n[CatalogItemVariation](entity:CatalogItemVariation) and quantity to transfer.", "x-release-status": "BETA", "required": ["item_variation_id", "quantity_ordered"], "properties": {"item_variation_id": {"type": "string", "description": "ID of the [CatalogItemVariation](entity:CatalogItemVariation) to transfer. Must reference a valid\nitem variation in the [Catalog](api:Catalog). The item variation must be:\n- Active and available for sale\n- Enabled for inventory tracking\n- Available at the source location", "minLength": 1, "maxLength": 64}, "quantity_ordered": {"type": "string", "description": "Total quantity ordered", "minLength": 1, "maxLength": 16, "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,4})?$"}}}, "description": "List of [CatalogItemVariation](entity:CatalogItemVariation)s to transfer, including quantities", "nullable": true}}}}, "example": {"idempotency_key": "65cc0586-3e82-384s-b524-3885cffd52", "transfer_order": {"created_by_team_member_id": "EXAMPLE_TEAM_MEMBER_ID_789", "destination_location_id": "EXAMPLE_DEST_LOCATION_ID_456", "expected_at": "2025-11-09T05:00:00Z", "line_items": [{"item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_001", "quantity_ordered": "5"}, {"item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_002", "quantity_ordered": "3"}], "notes": "Example transfer order for inventory redistribution between locations", "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123", "tracking_number": "TRACK123456789"}}}',  # noqa: E501
    "UPDATETRANSFERORDER": '{"type": "object", "description": "Request to update a transfer order", "x-release-status": "BETA", "required": ["idempotency_key", "transfer_order"], "properties": {"idempotency_key": {"type": "string", "description": "A unique string that identifies this UpdateTransferOrder request. Keys must contain only alphanumeric characters, dashes and underscores", "minLength": 1}, "transfer_order": {"type": "object", "description": "Data model for updating a transfer order. All fields are optional.", "x-release-status": "BETA", "properties": {"source_location_id": {"type": "string", "description": "The source [Location](entity:Location) that will send the items. Must be an active location\nin your Square account with sufficient inventory of the requested items.", "minLength": 1, "maxLength": 64, "nullable": true}, "destination_location_id": {"type": "string", "description": "The destination [Location](entity:Location) that will receive the items. Must be an active location\nin your Square account.", "minLength": 1, "maxLength": 64, "nullable": true}, "expected_at": {"type": "string", "description": "Expected transfer date in RFC 3339 format (e.g. "2023-10-01T12:00:00Z").", "nullable": true}, "notes": {"type": "string", "description": "Optional notes about the transfer", "maxLength": 4096, "nullable": true}, "tracking_number": {"type": "string", "description": "Shipment tracking number", "maxLength": 64, "nullable": true}, "line_items": {"type": "array", "items": {"type": "object", "description": "Represents a line item update in a transfer order", "x-release-status": "BETA", "properties": {"uid": {"type": "string", "description": "Line item id being updated. Required for updating/removing existing line items, but should not be set for new line items.", "minLength": 1, "maxLength": 64, "nullable": true}, "item_variation_id": {"type": "string", "description": "Catalog item variation being transferred\n\nRequired for new line items, but otherwise is not updatable.", "minLength": 1, "maxLength": 64, "nullable": true}, "quantity_ordered": {"type": "string", "description": "Total quantity ordered", "minLength": 1, "maxLength": 16, "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,4})?$", "nullable": true}, "remove": {"type": "boolean", "description": "Flag to remove the line item during update. Must include `uid` in removal request", "nullable": true}}}, "description": "List of items being transferred", "nullable": true}}}, "version": {"type": "integer", "description": "Version for optimistic concurrency", "format": "int64"}}, "example": {"idempotency_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "transfer_order": {"destination_location_id": "EXAMPLE_DEST_LOCATION_ID_101", "expected_at": "2025-11-10T08:00:00Z", "line_items": [{"quantity_ordered": "7", "uid": "1"}, {"item_variation_id": "EXAMPLE_NEW_ITEM_VARIATION_ID_003", "quantity_ordered": "2"}, {"remove": true, "uid": "2"}], "notes": "Updated: Priority transfer due to low stock at destination", "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_789", "tracking_number": "TRACK987654321"}, "transfer_order_id": "EXAMPLE_TRANSFER_ORDER_ID_123", "version": 1753109537351}}',  # noqa: E501
    "RECORDTRANSFERORDERRECEIPT": '{"type": "object", "description": "Request to record receipt of items for a transfer order", "x-release-status": "BETA", "required": ["idempotency_key", "receipt"], "properties": {"idempotency_key": {"type": "string", "description": "A unique key to make this request idempotent", "minLength": 1}, "receipt": {"type": "object", "description": "The goods receipt details for a transfer order. This object represents a single receipt\nof goods against a transfer order, tracking:\n\n- Which [CatalogItemVariation](entity:CatalogItemVariation)s were received\n- Quantities received in good condition\n- Quantities damaged during transit/handling\n- Quantities canceled during receipt\n\nMultiple goods receipts can be created for a single transfer order to handle:\n- Partial deliveries\n- Multiple shipments\n- Split receipts across different dates\n- Cancellations of specific quantities\n\nEach receipt automatically:\n- Updates the transfer order status\n- Adjusts received quantities\n- Updates inventory levels at both source and destination [Location](entity:Location)s", "x-release-status": "BETA", "properties": {"line_items": {"type": "array", "items": {"type": "object", "description": "A simplified line item for goods receipts in transfer orders", "x-release-status": "BETA", "required": ["transfer_order_line_uid"], "properties": {"transfer_order_line_uid": {"type": "string", "description": "The unique identifier of the Transfer Order line being received", "maxLength": 64}, "quantity_received": {"type": "string", "description": "The quantity received for this line item as a decimal string (e.g. "10.5").\nThese items will be added to the destination [Location](entity:Location)\'s inventory with [InventoryState](entity:InventoryState) of IN_STOCK.", "minLength": 1, "maxLength": 16, "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,4})?$", "nullable": true}, "quantity_damaged": {"type": "string", "description": "The quantity that was damaged during shipping/handling as a decimal string (e.g. "1.5").\nThese items will be added to the destination [Location](entity:Location)\'s inventory with [InventoryState](entity:InventoryState) of WASTE.", "minLength": 1, "maxLength": 16, "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,4})?$", "nullable": true}, "quantity_canceled": {"type": "string", "description": "The quantity that was canceled during shipping/handling as a decimal string (e.g. "1.5"). These will be immediately added to inventory in the source location.", "minLength": 1, "maxLength": 16, "pattern": "^(0|[1-9]\\d*)(\\.\\d{1,4})?$", "nullable": true}}}, "description": "Line items being received. Each line item specifies:\n- The item being received\n- Quantity received in good condition\n- Quantity received damaged\n- Quantity canceled\n\nConstraints:\n- Must include at least one line item\n- Maximum of 1000 line items per receipt\n- Each line item must reference a valid item from the transfer order\n- Total of received, damaged, and canceled quantities cannot exceed ordered quantity", "nullable": true}}}, "version": {"type": "integer", "description": "Version for optimistic concurrency", "format": "int64"}}, "example": {"idempotency_key": "EXAMPLE_IDEMPOTENCY_KEY_101", "receipt": {"line_items": [{"quantity_canceled": "1", "quantity_damaged": "1", "quantity_received": "3", "uid": "1"}, {"quantity_canceled": "1", "quantity_received": "2", "uid": "2"}]}, "transfer_order_id": "EXAMPLE_TRANSFER_ORDER_ID_123", "version": 1753118664873}}',  # noqa: E501
    "BULKCREATEVENDORS": '{"type": "object", "description": "Represents an input to a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).", "x-release-status": "BETA", "required": ["vendors"], "properties": {"vendors": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents a supplier to a seller.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [Vendor](entity:Vendor).\nThis field is required when attempting to update a [Vendor](entity:Vendor).", "maxLength": 100}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was created.", "maxLength": 34, "readOnly": true}, "updated_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was last updated.", "maxLength": 34, "readOnly": true}, "name": {"type": "string", "description": "The name of the [Vendor](entity:Vendor).\nThis field is required when attempting to create or update a [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "contacts": {"type": "array", "items": {"type": "object", "description": "Represents a contact of a [Vendor](entity:Vendor).", "x-release-status": "BETA", "required": ["ordinal"], "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [VendorContact](entity:VendorContact).\nThis field is required when attempting to update a [VendorContact](entity:VendorContact).", "maxLength": 100}, "name": {"type": "string", "description": "The name of the [VendorContact](entity:VendorContact).\nThis field is required when attempting to create a [Vendor](entity:Vendor).", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "removed": {"type": "boolean", "description": "The state of the [VendorContact](entity:VendorContact).", "nullable": true}, "ordinal": {"type": "integer", "description": "The ordinal of the [VendorContact](entity:VendorContact)."}}}, "description": "The contacts of the [Vendor](entity:Vendor).", "nullable": true}, "account_number": {"type": "string", "description": "The account number of the [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "A note detailing information about the [Vendor](entity:Vendor).", "maxLength": 4096, "nullable": true}, "version": {"type": "integer", "description": "The version of the [Vendor](entity:Vendor)."}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "Vendor is active and can receive purchase orders."}, {"name": "INACTIVE", "description": "Vendor is inactive and cannot receive purchase orders."}], "description": "The status of the [Vendor](entity:Vendor),\nwhether a [Vendor](entity:Vendor) is active or inactive.", "x-release-status": "BETA"}}}, "description": "Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs."}}, "example": {"47bb76a8-c9fb-4f33-9df8-25ce02ca4505": {"contacts": [{"email_address": "annie@annieshotsauce.com", "name": "Annie Thomas", "phone_number": "1-212-555-4250"}], "name": "Annie\u2019s Hot Sauce"}, "vendors": {"8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe": {"account_number": "4025391", "address": {"address_line_1": "505 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "contacts": [{"email_address": "joe@joesfreshseafood.com", "name": "Joe Burrow", "phone_number": "1-212-555-4250"}], "name": "Joe\'s Fresh Seafood", "note": "a vendor"}}}}',  # noqa: E501
    "BULKUPDATEVENDORS": '{"type": "object", "description": "Represents an input to a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).", "x-release-status": "BETA", "required": ["vendors"], "properties": {"vendors": {"type": "object", "additionalProperties": {"type": "object", "description": "Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).", "x-release-status": "BETA", "required": ["vendor"], "properties": {"idempotency_key": {"type": "string", "description": "A client-supplied, universally unique identifier (UUID) for the\nrequest.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", "maxLength": 128, "nullable": true}, "vendor": {"type": "object", "description": "Represents a supplier to a seller.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [Vendor](entity:Vendor).\nThis field is required when attempting to update a [Vendor](entity:Vendor).", "maxLength": 100}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was created.", "maxLength": 34, "readOnly": true}, "updated_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was last updated.", "maxLength": 34, "readOnly": true}, "name": {"type": "string", "description": "The name of the [Vendor](entity:Vendor).\nThis field is required when attempting to create or update a [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "contacts": {"type": "array", "items": {"type": "object", "description": "Represents a contact of a [Vendor](entity:Vendor).", "x-release-status": "BETA", "required": ["ordinal"], "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [VendorContact](entity:VendorContact).\nThis field is required when attempting to update a [VendorContact](entity:VendorContact).", "maxLength": 100}, "name": {"type": "string", "description": "The name of the [VendorContact](entity:VendorContact).\nThis field is required when attempting to create a [Vendor](entity:Vendor).", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "removed": {"type": "boolean", "description": "The state of the [VendorContact](entity:VendorContact).", "nullable": true}, "ordinal": {"type": "integer", "description": "The ordinal of the [VendorContact](entity:VendorContact)."}}}, "description": "The contacts of the [Vendor](entity:Vendor).", "nullable": true}, "account_number": {"type": "string", "description": "The account number of the [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "A note detailing information about the [Vendor](entity:Vendor).", "maxLength": 4096, "nullable": true}, "version": {"type": "integer", "description": "The version of the [Vendor](entity:Vendor)."}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "Vendor is active and can receive purchase orders."}, {"name": "INACTIVE", "description": "Vendor is inactive and cannot receive purchase orders."}], "description": "The status of the [Vendor](entity:Vendor),\nwhether a [Vendor](entity:Vendor) is active or inactive.", "x-release-status": "BETA"}}}}, "example": {"idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "vendor": {"id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", "name": "Jack\'s Chicken Shack", "status": "ACTIVE", "version": 1}}}, "description": "A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor)\nobjects. The set is represented by  a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs."}}, "example": {"vendors": {"FMCYHBWT1TPL8MFH52PBMEN92A": {"address": {"address_line_1": "202 Mill St", "administrative_district_level_1": "NJ", "country": "US", "locality": "Moorestown", "postal_code": "08057"}, "status": "ACTIVE", "version": 10}, "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4": {"note": "favorite vendor", "status": "ACTIVE", "version": 30}}}}',  # noqa: E501
    "CREATEVENDOR": '{"type": "object", "description": "Represents an input to a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).", "x-release-status": "BETA", "required": ["idempotency_key"], "properties": {"idempotency_key": {"type": "string", "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", "minLength": 1, "maxLength": 128}, "vendor": {"type": "object", "description": "Represents a supplier to a seller.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [Vendor](entity:Vendor).\nThis field is required when attempting to update a [Vendor](entity:Vendor).", "maxLength": 100}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was created.", "maxLength": 34, "readOnly": true}, "updated_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was last updated.", "maxLength": 34, "readOnly": true}, "name": {"type": "string", "description": "The name of the [Vendor](entity:Vendor).\nThis field is required when attempting to create or update a [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "contacts": {"type": "array", "items": {"type": "object", "description": "Represents a contact of a [Vendor](entity:Vendor).", "x-release-status": "BETA", "required": ["ordinal"], "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [VendorContact](entity:VendorContact).\nThis field is required when attempting to update a [VendorContact](entity:VendorContact).", "maxLength": 100}, "name": {"type": "string", "description": "The name of the [VendorContact](entity:VendorContact).\nThis field is required when attempting to create a [Vendor](entity:Vendor).", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "removed": {"type": "boolean", "description": "The state of the [VendorContact](entity:VendorContact).", "nullable": true}, "ordinal": {"type": "integer", "description": "The ordinal of the [VendorContact](entity:VendorContact)."}}}, "description": "The contacts of the [Vendor](entity:Vendor).", "nullable": true}, "account_number": {"type": "string", "description": "The account number of the [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "A note detailing information about the [Vendor](entity:Vendor).", "maxLength": 4096, "nullable": true}, "version": {"type": "integer", "description": "The version of the [Vendor](entity:Vendor)."}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "Vendor is active and can receive purchase orders."}, {"name": "INACTIVE", "description": "Vendor is inactive and cannot receive purchase orders."}], "description": "The status of the [Vendor](entity:Vendor),\nwhether a [Vendor](entity:Vendor) is active or inactive.", "x-release-status": "BETA"}}}}, "example": {"idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "vendor": {"account_number": "4025391", "address": {"address_line_1": "505 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003"}, "contacts": [{"email_address": "joe@joesfreshseafood.com", "name": "Joe Burrow", "phone_number": "1-212-555-4250"}], "name": "Joe\'s Fresh Seafood", "note": "a vendor"}}}',  # noqa: E501
    "UPDATEVENDORINFO": '{"type": "object", "description": "Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).", "x-release-status": "BETA", "required": ["vendor"], "properties": {"idempotency_key": {"type": "string", "description": "A client-supplied, universally unique identifier (UUID) for the\nrequest.\n\nSee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the\n[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more\ninformation.", "maxLength": 128, "nullable": true}, "vendor": {"type": "object", "description": "Represents a supplier to a seller.", "x-release-status": "BETA", "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [Vendor](entity:Vendor).\nThis field is required when attempting to update a [Vendor](entity:Vendor).", "maxLength": 100}, "created_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was created.", "maxLength": 34, "readOnly": true}, "updated_at": {"type": "string", "description": "An RFC 3339-formatted timestamp that indicates when the\n[Vendor](entity:Vendor) was last updated.", "maxLength": 34, "readOnly": true}, "name": {"type": "string", "description": "The name of the [Vendor](entity:Vendor).\nThis field is required when attempting to create or update a [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "address": {"type": "object", "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "x-release-status": "PUBLIC", "properties": {"address_line_1": {"type": "string", "description": "The first line of the address.\n\nFields that start with `address_line` provide the address\'s most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields).", "nullable": true}, "address_line_2": {"type": "string", "description": "The second line of the address, if any.", "nullable": true}, "address_line_3": {"type": "string", "description": "The third line of the address, if any.", "nullable": true}, "locality": {"type": "string", "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "sublocality": {"type": "string", "description": "A civil region within the address\'s `locality`, if any.", "nullable": true}, "sublocality_2": {"type": "string", "description": "A civil region within the address\'s `sublocality`, if any.", "nullable": true}, "sublocality_3": {"type": "string", "description": "A civil region within the address\'s `sublocality_2`, if any.", "nullable": true}, "administrative_district_level_1": {"type": "string", "description": "A civil entity within the address\'s country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "administrative_district_level_2": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_1`.\nIn the US, this is the county.", "nullable": true}, "administrative_district_level_3": {"type": "string", "description": "A civil entity within the address\'s `administrative_district_level_2`,\nif any.", "nullable": true}, "postal_code": {"type": "string", "description": "The address\'s postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).", "nullable": true}, "country": {"type": "string", "enum": ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"], "x-enum-elements": [{"name": "ZZ", "description": "Unknown"}, {"name": "AD", "description": "Andorra"}, {"name": "AE", "description": "United Arab Emirates"}, {"name": "AF", "description": "Afghanistan"}, {"name": "AG", "description": "Antigua and Barbuda"}, {"name": "AI", "description": "Anguilla"}, {"name": "AL", "description": "Albania"}, {"name": "AM", "description": "Armenia"}, {"name": "AO", "description": "Angola"}, {"name": "AQ", "description": "Antartica"}, {"name": "AR", "description": "Argentina"}, {"name": "AS", "description": "American Samoa"}, {"name": "AT", "description": "Austria"}, {"name": "AU", "description": "Australia"}, {"name": "AW", "description": "Aruba"}, {"name": "AX", "description": "\u00c5land Islands"}, {"name": "AZ", "description": "Azerbaijan"}, {"name": "BA", "description": "Bosnia and Herzegovina"}, {"name": "BB", "description": "Barbados"}, {"name": "BD", "description": "Bangladesh"}, {"name": "BE", "description": "Belgium"}, {"name": "BF", "description": "Burkina Faso"}, {"name": "BG", "description": "Bulgaria"}, {"name": "BH", "description": "Bahrain"}, {"name": "BI", "description": "Burundi"}, {"name": "BJ", "description": "Benin"}, {"name": "BL", "description": "Saint Barth\u00e9lemy"}, {"name": "BM", "description": "Bermuda"}, {"name": "BN", "description": "Brunei"}, {"name": "BO", "description": "Bolivia"}, {"name": "BQ", "description": "Bonaire"}, {"name": "BR", "description": "Brazil"}, {"name": "BS", "description": "Bahamas"}, {"name": "BT", "description": "Bhutan"}, {"name": "BV", "description": "Bouvet Island"}, {"name": "BW", "description": "Botswana"}, {"name": "BY", "description": "Belarus"}, {"name": "BZ", "description": "Belize"}, {"name": "CA", "description": "Canada"}, {"name": "CC", "description": "Cocos Islands"}, {"name": "CD", "description": "Democratic Republic of the Congo"}, {"name": "CF", "description": "Central African Republic"}, {"name": "CG", "description": "Congo"}, {"name": "CH", "description": "Switzerland"}, {"name": "CI", "description": "Ivory Coast"}, {"name": "CK", "description": "Cook Islands"}, {"name": "CL", "description": "Chile"}, {"name": "CM", "description": "Cameroon"}, {"name": "CN", "description": "China"}, {"name": "CO", "description": "Colombia"}, {"name": "CR", "description": "Costa Rica"}, {"name": "CU", "description": "Cuba"}, {"name": "CV", "description": "Cabo Verde"}, {"name": "CW", "description": "Cura\u00e7ao"}, {"name": "CX", "description": "Christmas Island"}, {"name": "CY", "description": "Cyprus"}, {"name": "CZ", "description": "Czechia"}, {"name": "DE", "description": "Germany"}, {"name": "DJ", "description": "Djibouti"}, {"name": "DK", "description": "Denmark"}, {"name": "DM", "description": "Dominica"}, {"name": "DO", "description": "Dominican Republic"}, {"name": "DZ", "description": "Algeria"}, {"name": "EC", "description": "Ecuador"}, {"name": "EE", "description": "Estonia"}, {"name": "EG", "description": "Egypt"}, {"name": "EH", "description": "Western Sahara"}, {"name": "ER", "description": "Eritrea"}, {"name": "ES", "description": "Spain"}, {"name": "ET", "description": "Ethiopia"}, {"name": "FI", "description": "Finland"}, {"name": "FJ", "description": "Fiji"}, {"name": "FK", "description": "Falkland Islands"}, {"name": "FM", "description": "Federated States of Micronesia"}, {"name": "FO", "description": "Faroe Islands"}, {"name": "FR", "description": "France"}, {"name": "GA", "description": "Gabon"}, {"name": "GB", "description": "United Kingdom"}, {"name": "GD", "description": "Grenada"}, {"name": "GE", "description": "Georgia"}, {"name": "GF", "description": "French Guiana"}, {"name": "GG", "description": "Guernsey"}, {"name": "GH", "description": "Ghana"}, {"name": "GI", "description": "Gibraltar"}, {"name": "GL", "description": "Greenland"}, {"name": "GM", "description": "Gambia"}, {"name": "GN", "description": "Guinea"}, {"name": "GP", "description": "Guadeloupe"}, {"name": "GQ", "description": "Equatorial Guinea"}, {"name": "GR", "description": "Greece"}, {"name": "GS", "description": "South Georgia and the South Sandwich Islands"}, {"name": "GT", "description": "Guatemala"}, {"name": "GU", "description": "Guam"}, {"name": "GW", "description": "Guinea-Bissau"}, {"name": "GY", "description": "Guyana"}, {"name": "HK", "description": "Hong Kong"}, {"name": "HM", "description": "Heard Island and McDonald Islands"}, {"name": "HN", "description": "Honduras"}, {"name": "HR", "description": "Croatia"}, {"name": "HT", "description": "Haiti"}, {"name": "HU", "description": "Hungary"}, {"name": "ID", "description": "Indonesia"}, {"name": "IE", "description": "Ireland"}, {"name": "IL", "description": "Israel"}, {"name": "IM", "description": "Isle of Man"}, {"name": "IN", "description": "India"}, {"name": "IO", "description": "British Indian Ocean Territory"}, {"name": "IQ", "description": "Iraq"}, {"name": "IR", "description": "Iran"}, {"name": "IS", "description": "Iceland"}, {"name": "IT", "description": "Italy"}, {"name": "JE", "description": "Jersey"}, {"name": "JM", "description": "Jamaica"}, {"name": "JO", "description": "Jordan"}, {"name": "JP", "description": "Japan"}, {"name": "KE", "description": "Kenya"}, {"name": "KG", "description": "Kyrgyzstan"}, {"name": "KH", "description": "Cambodia"}, {"name": "KI", "description": "Kiribati"}, {"name": "KM", "description": "Comoros"}, {"name": "KN", "description": "Saint Kitts and Nevis"}, {"name": "KP", "description": "Democratic People\'s Republic of Korea"}, {"name": "KR", "description": "Republic of Korea"}, {"name": "KW", "description": "Kuwait"}, {"name": "KY", "description": "Cayman Islands"}, {"name": "KZ", "description": "Kazakhstan"}, {"name": "LA", "description": "Lao People\'s Democratic Republic"}, {"name": "LB", "description": "Lebanon"}, {"name": "LC", "description": "Saint Lucia"}, {"name": "LI", "description": "Liechtenstein"}, {"name": "LK", "description": "Sri Lanka"}, {"name": "LR", "description": "Liberia"}, {"name": "LS", "description": "Lesotho"}, {"name": "LT", "description": "Lithuania"}, {"name": "LU", "description": "Luxembourg"}, {"name": "LV", "description": "Latvia"}, {"name": "LY", "description": "Libya"}, {"name": "MA", "description": "Morocco"}, {"name": "MC", "description": "Monaco"}, {"name": "MD", "description": "Moldova"}, {"name": "ME", "description": "Montenegro"}, {"name": "MF", "description": "Saint Martin"}, {"name": "MG", "description": "Madagascar"}, {"name": "MH", "description": "Marshall Islands"}, {"name": "MK", "description": "North Macedonia"}, {"name": "ML", "description": "Mali"}, {"name": "MM", "description": "Myanmar"}, {"name": "MN", "description": "Mongolia"}, {"name": "MO", "description": "Macao"}, {"name": "MP", "description": "Northern Mariana Islands"}, {"name": "MQ", "description": "Martinique"}, {"name": "MR", "description": "Mauritania"}, {"name": "MS", "description": "Montserrat"}, {"name": "MT", "description": "Malta"}, {"name": "MU", "description": "Mauritius"}, {"name": "MV", "description": "Maldives"}, {"name": "MW", "description": "Malawi"}, {"name": "MX", "description": "Mexico"}, {"name": "MY", "description": "Malaysia"}, {"name": "MZ", "description": "Mozambique"}, {"name": "NA", "description": "Namibia"}, {"name": "NC", "description": "New Caledonia"}, {"name": "NE", "description": "Niger"}, {"name": "NF", "description": "Norfolk Island"}, {"name": "NG", "description": "Nigeria"}, {"name": "NI", "description": "Nicaragua"}, {"name": "NL", "description": "Netherlands"}, {"name": "NO", "description": "Norway"}, {"name": "NP", "description": "Nepal"}, {"name": "NR", "description": "Nauru"}, {"name": "NU", "description": "Niue"}, {"name": "NZ", "description": "New Zealand"}, {"name": "OM", "description": "Oman"}, {"name": "PA", "description": "Panama"}, {"name": "PE", "description": "Peru"}, {"name": "PF", "description": "French Polynesia"}, {"name": "PG", "description": "Papua New Guinea"}, {"name": "PH", "description": "Philippines"}, {"name": "PK", "description": "Pakistan"}, {"name": "PL", "description": "Poland"}, {"name": "PM", "description": "Saint Pierre and Miquelon"}, {"name": "PN", "description": "Pitcairn"}, {"name": "PR", "description": "Puerto Rico"}, {"name": "PS", "description": "Palestine"}, {"name": "PT", "description": "Portugal"}, {"name": "PW", "description": "Palau"}, {"name": "PY", "description": "Paraguay"}, {"name": "QA", "description": "Qatar"}, {"name": "RE", "description": "R\u00e9union"}, {"name": "RO", "description": "Romania"}, {"name": "RS", "description": "Serbia"}, {"name": "RU", "description": "Russia"}, {"name": "RW", "description": "Rwanda"}, {"name": "SA", "description": "Saudi Arabia"}, {"name": "SB", "description": "Solomon Islands"}, {"name": "SC", "description": "Seychelles"}, {"name": "SD", "description": "Sudan"}, {"name": "SE", "description": "Sweden"}, {"name": "SG", "description": "Singapore"}, {"name": "SH", "description": "Saint Helena, Ascension and Tristan da Cunha"}, {"name": "SI", "description": "Slovenia"}, {"name": "SJ", "description": "Svalbard and Jan Mayen"}, {"name": "SK", "description": "Slovakia"}, {"name": "SL", "description": "Sierra Leone"}, {"name": "SM", "description": "San Marino"}, {"name": "SN", "description": "Senegal"}, {"name": "SO", "description": "Somalia"}, {"name": "SR", "description": "Suriname"}, {"name": "SS", "description": "South Sudan"}, {"name": "ST", "description": "Sao Tome and Principe"}, {"name": "SV", "description": "El Salvador"}, {"name": "SX", "description": "Sint Maarten"}, {"name": "SY", "description": "Syrian Arab Republic"}, {"name": "SZ", "description": "Eswatini"}, {"name": "TC", "description": "Turks and Caicos Islands"}, {"name": "TD", "description": "Chad"}, {"name": "TF", "description": "French Southern Territories"}, {"name": "TG", "description": "Togo"}, {"name": "TH", "description": "Thailand"}, {"name": "TJ", "description": "Tajikistan"}, {"name": "TK", "description": "Tokelau"}, {"name": "TL", "description": "Timor-Leste"}, {"name": "TM", "description": "Turkmenistan"}, {"name": "TN", "description": "Tunisia"}, {"name": "TO", "description": "Tonga"}, {"name": "TR", "description": "Turkey"}, {"name": "TT", "description": "Trinidad and Tobago"}, {"name": "TV", "description": "Tuvalu"}, {"name": "TW", "description": "Taiwan"}, {"name": "TZ", "description": "Tanzania"}, {"name": "UA", "description": "Ukraine"}, {"name": "UG", "description": "Uganda"}, {"name": "UM", "description": "United States Minor Outlying Islands"}, {"name": "US", "description": "United States of America"}, {"name": "UY", "description": "Uruguay"}, {"name": "UZ", "description": "Uzbekistan"}, {"name": "VA", "description": "Vatican City"}, {"name": "VC", "description": "Saint Vincent and the Grenadines"}, {"name": "VE", "description": "Venezuela"}, {"name": "VG", "description": "British Virgin Islands"}, {"name": "VI", "description": "U.S. Virgin Islands"}, {"name": "VN", "description": "Vietnam"}, {"name": "VU", "description": "Vanuatu"}, {"name": "WF", "description": "Wallis and Futuna"}, {"name": "WS", "description": "Samoa"}, {"name": "YE", "description": "Yemen"}, {"name": "YT", "description": "Mayotte"}, {"name": "ZA", "description": "South Africa"}, {"name": "ZM", "description": "Zambia"}, {"name": "ZW", "description": "Zimbabwe"}], "description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).", "x-release-status": "PUBLIC"}, "first_name": {"type": "string", "description": "Optional first name when it\'s representing recipient.", "nullable": true}, "last_name": {"type": "string", "description": "Optional last name when it\'s representing recipient.", "nullable": true}}}, "contacts": {"type": "array", "items": {"type": "object", "description": "Represents a contact of a [Vendor](entity:Vendor).", "x-release-status": "BETA", "required": ["ordinal"], "properties": {"id": {"type": "string", "description": "A unique Square-generated ID for the [VendorContact](entity:VendorContact).\nThis field is required when attempting to update a [VendorContact](entity:VendorContact).", "maxLength": 100}, "name": {"type": "string", "description": "The name of the [VendorContact](entity:VendorContact).\nThis field is required when attempting to create a [Vendor](entity:Vendor).", "maxLength": 255, "nullable": true}, "email_address": {"type": "string", "description": "The email address of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "phone_number": {"type": "string", "description": "The phone number of the [VendorContact](entity:VendorContact).", "maxLength": 255, "nullable": true}, "removed": {"type": "boolean", "description": "The state of the [VendorContact](entity:VendorContact).", "nullable": true}, "ordinal": {"type": "integer", "description": "The ordinal of the [VendorContact](entity:VendorContact)."}}}, "description": "The contacts of the [Vendor](entity:Vendor).", "nullable": true}, "account_number": {"type": "string", "description": "The account number of the [Vendor](entity:Vendor).", "maxLength": 100, "nullable": true}, "note": {"type": "string", "description": "A note detailing information about the [Vendor](entity:Vendor).", "maxLength": 4096, "nullable": true}, "version": {"type": "integer", "description": "The version of the [Vendor](entity:Vendor)."}, "status": {"type": "string", "enum": ["ACTIVE", "INACTIVE"], "x-enum-elements": [{"name": "ACTIVE", "description": "Vendor is active and can receive purchase orders."}, {"name": "INACTIVE", "description": "Vendor is inactive and cannot receive purchase orders."}], "description": "The status of the [Vendor](entity:Vendor),\nwhether a [Vendor](entity:Vendor) is active or inactive.", "x-release-status": "BETA"}}}}, "example": {"idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe", "vendor": {"id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4", "name": "Jack\'s Chicken Shack", "status": "ACTIVE", "version": 1}}}',  # noqa: E501
}
