Square · Schema
CreatePaymentLinkRequest
BookingLocationSquareRestaurantCatalogCheckoutCustomersDisputesE-CommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLoyaltyMerchantsOrderPaymentsPoint-of-SaleRefundsRetailSubscriptionTeamWebhookPayment ProcessingPayment Terminals
Properties
| Name | Type | Description |
|---|---|---|
| idempotency_key | string | A unique string that identifies this `CreatePaymentLinkRequest` request. If you do not provide a unique string (or provide an empty string as the value), the endpoint treats each request as independen |
| description | string | A description of the payment link. You provide this optional description that is useful in your application context. It is not used anywhere. |
| quick_pay | object | Describes an ad hoc item and price for which to generate a quick pay checkout link. For more information, see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). |
| order | object | Describes the `Order` for which to create a checkout link. For more information, see [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout). |
| checkout_options | object | Describes optional fields to add to the resulting checkout page. For more information, see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configu |
| pre_populated_data | object | Describes fields to prepopulate in the resulting checkout page. For more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configur |
| payment_note | string | A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-create-payment-link-request-schema.json",
"title": "CreatePaymentLinkRequest",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/square-checkout-api-openapi.yml#/components/schemas/CreatePaymentLinkRequest",
"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": {
"$ref": "#/$defs/QuickPay",
"description": "Describes an ad hoc item and price for which to generate a quick pay checkout link.\nFor more information,\nsee [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout)."
},
"order": {
"$ref": "#/$defs/Order",
"description": "Describes the `Order` for which to create a checkout link.\nFor more information,\nsee [Square Order Checkout](https://developer.squareup.com/docs/checkout-api/square-order-checkout)."
},
"checkout_options": {
"$ref": "#/$defs/CheckoutOptions",
"description": "Describes optional fields to add to the resulting checkout page.\nFor more information,\nsee [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations)."
},
"pre_populated_data": {
"$ref": "#/$defs/PrePopulatedData",
"description": "Describes fields to prepopulate in the resulting checkout page.\nFor more information, see [Prepopulate the shipping address](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#prepopulate-the-shipping-address)."
},
"payment_note": {
"type": "string",
"description": "A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.",
"maxLength": 500
}
},
"$defs": {
"AcceptedPaymentMethods": {
"type": "object",
"x-release-status": "PUBLIC",
"properties": {
"apple_pay": {
"type": [
"boolean",
"null"
],
"description": "Whether Apple Pay is accepted at checkout."
},
"google_pay": {
"type": [
"boolean",
"null"
],
"description": "Whether Google Pay is accepted at checkout."
},
"cash_app_pay": {
"type": [
"boolean",
"null"
],
"description": "Whether Cash App Pay is accepted at checkout."
},
"afterpay_clearpay": {
"type": [
"boolean",
"null"
],
"description": "Whether Afterpay/Clearpay is accepted at checkout."
}
}
},
"AdditionalRecipient": {
"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",
"null"
],
"description": "The description of the additional recipient.",
"maxLength": 100
},
"amount_money": {
"$ref": "#/$defs/Money",
"description": "The amount of money distributed to the recipient."
},
"receivable_id": {
"type": [
"string",
"null"
],
"description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.",
"maxLength": 192
}
}
},
"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",
"null"
],
"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)."
},
"address_line_2": {
"type": [
"string",
"null"
],
"description": "The second line of the address, if any."
},
"address_line_3": {
"type": [
"string",
"null"
],
"description": "The third line of the address, if any."
},
"locality": {
"type": [
"string",
"null"
],
"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)."
},
"sublocality": {
"type": [
"string",
"null"
],
"description": "A civil region within the address's `locality`, if any."
},
"sublocality_2": {
"type": [
"string",
"null"
],
"description": "A civil region within the address's `sublocality`, if any."
},
"sublocality_3": {
"type": [
"string",
"null"
],
"description": "A civil region within the address's `sublocality_2`, if any."
},
"administrative_district_level_1": {
"type": [
"string",
"null"
],
"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)."
},
"administrative_district_level_2": {
"type": [
"string",
"null"
],
"description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
},
"administrative_district_level_3": {
"type": [
"string",
"null"
],
"description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
},
"postal_code": {
"type": [
"string",
"null"
],
"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)."
},
"country": {
"$ref": "#/$defs/Country",
"description": "The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`.\nSee [Country](#type-country) for possible values"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "Optional first name when it's representing recipient."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "Optional last name when it's representing recipient."
}
}
},
"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": {
"$ref": "#/$defs/CardBrand",
"description": "The card's brand.\nSee [CardBrand](#type-cardbrand) for possible values",
"readOnly": true
},
"last_4": {
"type": "string",
"description": "The last 4 digits of the card number.",
"maxLength": 4,
"readOnly": true
},
"exp_month": {
"type": [
"integer",
"null"
],
"description": "The expiration month of the associated card as an integer between 1 and 12.",
"format": "int64"
},
"exp_year": {
"type": [
"integer",
"null"
],
"description": "The four-digit year of the card's expiration date.",
"format": "int64"
},
"cardholder_name": {
"type": [
"string",
"null"
],
"description": "The name of the cardholder.",
"maxLength": 96
},
"billing_address": {
"$ref": "#/$defs/Address",
"description": "The billing address for this card."
},
"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",
"null"
],
"description": "**Required** The ID of a customer created using the Customers API to be associated with the card."
},
"merchant_id": {
"type": "string",
"description": "The ID of the merchant associated with the card.",
"readOnly": true
},
"reference_id": {
"type": [
"string",
"null"
],
"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
},
"enabled": {
"type": "boolean",
"description": "Indicates whether or not a card can be used for payments.",
"readOnly": true
},
"card_type": {
"$ref": "#/$defs/CardType",
"description": "The type of the card.\nThe Card object includes this field only in response to Payments API calls.\nSee [CardType](#type-cardtype) for possible values",
"readOnly": true
},
"prepaid_type": {
"$ref": "#/$defs/CardPrepaidType",
"description": "Indicates whether the Card is prepaid or not.\nThe Card object includes this field only in response to Payments API calls.\nSee [CardPrepaidType](#type-cardprepaidtype) for possible values",
"readOnly": true
},
"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": {
"$ref": "#/$defs/CardCoBrand",
"description": "The card's co-brand if available. For example, an Afterpay virtual card would have a\nco-brand of AFTERPAY.\nSee [CardCoBrand](#type-cardcobrand) for possible values",
"readOnly": true
}
}
},
"CardBrand": {
"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"
},
"CardCoBrand": {
"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"
},
"CardPrepaidType": {
"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"
},
"CardType": {
"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"
},
"CheckoutOptions": {
"type": "object",
"x-release-status": "PUBLIC",
"properties": {
"allow_tipping": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the payment allows tipping."
},
"custom_fields": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CustomField"
},
"description": "The custom fields requesting information from the buyer."
},
"subscription_plan_id": {
"type": [
"string",
"null"
],
"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
},
"redirect_url": {
"type": [
"string",
"null"
],
"description": "The confirmation page URL to redirect the buyer to after Square processes the payment.",
"maxLength": 2048
},
"merchant_support_email": {
"type": [
"string",
"null"
],
"description": "The email address that buyers can use to contact the seller.",
"maxLength": 256
},
"ask_for_shipping_address": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether to include the address fields in the payment form."
},
"accepted_payment_methods": {
"$ref": "#/$defs/AcceptedPaymentMethods",
"description": "The methods allowed for buyers during checkout."
},
"app_fee_money": {
"$ref": "#/$defs/Money",
"description": "The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.\n\nThe amount cannot be more than 90% of the total amount of the payment.\n\nThe amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-monetary-amounts).\n\nThe fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees).\n\nTo set this field, `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission is required. For more information, see [Permissions](https://developer.squareup.com/docs/payments-api/collect-fees/additional-considerations#permissions)."
},
"shipping_fee": {
"$ref": "#/$defs/ShippingFee",
"description": "The fee associated with shipping to be applied to the `Order` as a service charge."
},
"enable_coupon": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form."
},
"enable_loyalty": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both."
}
}
},
"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": "Åland 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élemy"
},
{
"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çao"
},
{
"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",
"descripti
# --- truncated at 32 KB (212 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-payment-link-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/square-create-payment-link-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.