admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/AddCardToMerchant.json
jottakka f2332a7682
[Moar][Rewrapping] Rewrapping tools (#653) 
## Rewrapping

- Calendly
- Airtable
- Squareup
- PagerDuty
- Trello
- Miro

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-24 18:05:33 -03:00

1279 lines
112 KiB
JSON
Raw Blame History

{
"name": "AddCardToMerchant",
"fully_qualified_name": "SquareupApi.AddCardToMerchant@2.0.0",
"description": "Adds a card on file to an existing merchant.\n\nThis tool is used to store a new card on file for an existing merchant, facilitating future transactions. It provides confirmation once the card is successfully added.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "card_request_data",
"required": true,
"description": "JSON object with details required to add a card on file, including idempotency_key, source_id, and card information.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"idempotency_key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"source_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id."
},
"verification_token": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID for this card. Generated by Square."
},
"card_brand": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"OTHER_BRAND",
"VISA",
"MASTERCARD",
"AMERICAN_EXPRESS",
"DISCOVER",
"DISCOVER_DINERS",
"JCB",
"CHINA_UNIONPAY",
"SQUARE_GIFT_CARD",
"SQUARE_CAPITAL_CARD",
"INTERAC",
"EFTPOS",
"FELICA",
"EBT"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's brand, such as `VISA` or `MASTERCARD`."
},
"last_4": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The last 4 digits of the card number."
},
"exp_month": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The expiration month of the associated card as an integer between 1 and 12."
},
"exp_year": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The four-digit year of the card's expiration date."
},
"cardholder_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the cardholder."
},
"billing_address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"address_line_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The second line of the address, if any."
},
"address_line_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The third line of the address, if any."
},
"locality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `locality`, if any."
},
"sublocality_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality`, if any."
},
"sublocality_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality_2`, if any."
},
"administrative_district_level_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
},
"administrative_district_level_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
},
"postal_code": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"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"
],
"properties": null,
"inner_properties": null,
"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)."
},
"first_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional first name when it's representing recipient."
},
"last_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional last name when it's representing recipient."
}
},
"inner_properties": null,
"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)."
},
"fingerprint": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card."
},
"merchant_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the merchant associated with the card."
},
"reference_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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."
},
"enabled": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether or not a card can be used for payments."
},
"card_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_CARD_TYPE",
"CREDIT",
"DEBIT"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's type, such as `CREDIT` or `DEBIT`."
},
"prepaid_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_PREPAID_TYPE",
"NOT_PREPAID",
"PREPAID"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`."
},
"bin": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field."
},
"version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"card_co_brand": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN",
"AFTERPAY",
"CLEARPAY"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the brand for a co-branded card."
},
"issuer_alert": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ISSUER_ALERT_CARD_CLOSED"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the type of issuer alert for a [card on file](entity:Card)."
},
"issuer_alert_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"hsa_fsa": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN."
}
},
"inner_properties": null,
"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."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'CreateCard'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-squareup",
"provider_type": "oauth2",
"id": null,
"oauth2": null
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the squareup API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://connect.squareup.com/v2/cards",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "requestBody",
"tool_parameter_name": "card_request_data",
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"idempotency_key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"source_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id."
},
"verification_token": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID for this card. Generated by Square."
},
"card_brand": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"OTHER_BRAND",
"VISA",
"MASTERCARD",
"AMERICAN_EXPRESS",
"DISCOVER",
"DISCOVER_DINERS",
"JCB",
"CHINA_UNIONPAY",
"SQUARE_GIFT_CARD",
"SQUARE_CAPITAL_CARD",
"INTERAC",
"EFTPOS",
"FELICA",
"EBT"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's brand, such as `VISA` or `MASTERCARD`."
},
"last_4": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The last 4 digits of the card number."
},
"exp_month": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The expiration month of the associated card as an integer between 1 and 12."
},
"exp_year": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The four-digit year of the card's expiration date."
},
"cardholder_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the cardholder."
},
"billing_address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"address_line_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The second line of the address, if any."
},
"address_line_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The third line of the address, if any."
},
"locality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `locality`, if any."
},
"sublocality_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality`, if any."
},
"sublocality_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality_2`, if any."
},
"administrative_district_level_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
},
"administrative_district_level_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
},
"postal_code": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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": {
"val_type": "string",
"inner_val_type": null,
"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"
],
"properties": null,
"inner_properties": null,
"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)."
},
"first_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional first name when it's representing recipient."
},
"last_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional last name when it's representing recipient."
}
},
"inner_properties": null,
"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)."
},
"fingerprint": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "**Required** The ID of a [customer](entity:Customer) to be associated with the card."
},
"merchant_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the merchant associated with the card."
},
"reference_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": 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."
},
"enabled": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether or not a card can be used for payments."
},
"card_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_CARD_TYPE",
"CREDIT",
"DEBIT"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's type, such as `CREDIT` or `DEBIT`."
},
"prepaid_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_PREPAID_TYPE",
"NOT_PREPAID",
"PREPAID"
],
"properties": null,
"inner_properties": null,
"description": "Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`."
},
"bin": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field."
},
"version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"card_co_brand": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN",
"AFTERPAY",
"CLEARPAY"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the brand for a co-branded card."
},
"issuer_alert": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ISSUER_ALERT_CARD_CLOSED"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the type of issuer alert for a [card on file](entity:Card)."
},
"issuer_alert_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"hsa_fsa": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\nSpending Account (FSA), based on the card BIN."
}
},
"inner_properties": null,
"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."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Creates a card from the source (payment token or payment id). Accessible via\\nHTTP requests at POST https://connect.squareup.com/v2/cards\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"idempotency_key\",\n \"source_id\",\n \"card\"\n ],\n \"properties\": {\n \"idempotency_key\": {\n \"type\": \"string\",\n \"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.\",\n \"minLength\": 1\n },\n \"source_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.\",\n \"minLength\": 1,\n \"maxLength\": 16384\n },\n \"verification_token\": {\n \"type\": \"string\",\n \"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).\"\n },\n \"card\": {\n \"type\": \"object\",\n \"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.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Unique ID for this card. Generated by Square.\",\n \"maxLength\": 64,\n \"readOnly\": true\n },\n \"card_brand\": {\n \"type\": \"string\",\n \"enum\": [\n \"OTHER_BRAND\",\n \"VISA\",\n \"MASTERCARD\",\n \"AMERICAN_EXPRESS\",\n \"DISCOVER\",\n \"DISCOVER_DINERS\",\n \"JCB\",\n \"CHINA_UNIONPAY\",\n \"SQUARE_GIFT_CARD\",\n \"SQUARE_CAPITAL_CARD\",\n \"INTERAC\",\n \"EFTPOS\",\n \"FELICA\",\n \"EBT\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"OTHER_BRAND\",\n \"description\": \"\"\n },\n {\n \"name\": \"VISA\",\n \"description\": \"\"\n },\n {\n \"name\": \"MASTERCARD\",\n \"description\": \"\"\n },\n {\n \"name\": \"AMERICAN_EXPRESS\",\n \"description\": \"\"\n },\n {\n \"name\": \"DISCOVER\",\n \"description\": \"\"\n },\n {\n \"name\": \"DISCOVER_DINERS\",\n \"description\": \"\"\n },\n {\n \"name\": \"JCB\",\n \"description\": \"\"\n },\n {\n \"name\": \"CHINA_UNIONPAY\",\n \"description\": \"\"\n },\n {\n \"name\": \"SQUARE_GIFT_CARD\",\n \"description\": \"\"\n },\n {\n \"name\": \"SQUARE_CAPITAL_CARD\",\n \"description\": \"\"\n },\n {\n \"name\": \"INTERAC\",\n \"description\": \"\"\n },\n {\n \"name\": \"EFTPOS\",\n \"description\": \"\"\n },\n {\n \"name\": \"FELICA\",\n \"description\": \"\"\n },\n {\n \"name\": \"EBT\",\n \"description\": \"\"\n }\n ],\n \"description\": \"Indicates a card's brand, such as `VISA` or `MASTERCARD`.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"last_4\": {\n \"type\": \"string\",\n \"description\": \"The last 4 digits of the card number.\",\n \"maxLength\": 4,\n \"readOnly\": true\n },\n \"exp_month\": {\n \"type\": \"integer\",\n \"description\": \"The expiration month of the associated card as an integer between 1 and 12.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"exp_year\": {\n \"type\": \"integer\",\n \"description\": \"The four-digit year of the card's expiration date.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"cardholder_name\": {\n \"type\": \"string\",\n \"description\": \"The name of the cardholder.\",\n \"maxLength\": 96,\n \"nullable\": true\n },\n \"billing_address\": {\n \"type\": \"object\",\n \"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).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"address_line_1\": {\n \"type\": \"string\",\n \"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).\",\n \"nullable\": true\n },\n \"address_line_2\": {\n \"type\": \"string\",\n \"description\": \"The second line of the address, if any.\",\n \"nullable\": true\n },\n \"address_line_3\": {\n \"type\": \"string\",\n \"description\": \"The third line of the address, if any.\",\n \"nullable\": true\n },\n \"locality\": {\n \"type\": \"string\",\n \"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).\",\n \"nullable\": true\n },\n \"sublocality\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `locality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_2\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_3\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality_2`, if any.\",\n \"nullable\": true\n },\n \"administrative_district_level_1\": {\n \"type\": \"string\",\n \"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).\",\n \"nullable\": true\n },\n \"administrative_district_level_2\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_1`.\\nIn the US, this is the county.\",\n \"nullable\": true\n },\n \"administrative_district_level_3\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_2`,\\nif any.\",\n \"nullable\": true\n },\n \"postal_code\": {\n \"type\": \"string\",\n \"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).\",\n \"nullable\": true\n },\n \"country\": {\n \"type\": \"string\",\n \"enum\": [\n \"ZZ\",\n \"AD\",\n \"AE\",\n \"AF\",\n \"AG\",\n \"AI\",\n \"AL\",\n \"AM\",\n \"AO\",\n \"AQ\",\n \"AR\",\n \"AS\",\n \"AT\",\n \"AU\",\n \"AW\",\n \"AX\",\n \"AZ\",\n \"BA\",\n \"BB\",\n \"BD\",\n \"BE\",\n \"BF\",\n \"BG\",\n \"BH\",\n \"BI\",\n \"BJ\",\n \"BL\",\n \"BM\",\n \"BN\",\n \"BO\",\n \"BQ\",\n \"BR\",\n \"BS\",\n \"BT\",\n \"BV\",\n \"BW\",\n \"BY\",\n \"BZ\",\n \"CA\",\n \"CC\",\n \"CD\",\n \"CF\",\n \"CG\",\n \"CH\",\n \"CI\",\n \"CK\",\n \"CL\",\n \"CM\",\n \"CN\",\n \"CO\",\n \"CR\",\n \"CU\",\n \"CV\",\n \"CW\",\n \"CX\",\n \"CY\",\n \"CZ\",\n \"DE\",\n \"DJ\",\n \"DK\",\n \"DM\",\n \"DO\",\n \"DZ\",\n \"EC\",\n \"EE\",\n \"EG\",\n \"EH\",\n \"ER\",\n \"ES\",\n \"ET\",\n \"FI\",\n \"FJ\",\n \"FK\",\n \"FM\",\n \"FO\",\n \"FR\",\n \"GA\",\n \"GB\",\n \"GD\",\n \"GE\",\n \"GF\",\n \"GG\",\n \"GH\",\n \"GI\",\n \"GL\",\n \"GM\",\n \"GN\",\n \"GP\",\n \"GQ\",\n \"GR\",\n \"GS\",\n \"GT\",\n \"GU\",\n \"GW\",\n \"GY\",\n \"HK\",\n \"HM\",\n \"HN\",\n \"HR\",\n \"HT\",\n \"HU\",\n \"ID\",\n \"IE\",\n \"IL\",\n \"IM\",\n \"IN\",\n \"IO\",\n \"IQ\",\n \"IR\",\n \"IS\",\n \"IT\",\n \"JE\",\n \"JM\",\n \"JO\",\n \"JP\",\n \"KE\",\n \"KG\",\n \"KH\",\n \"KI\",\n \"KM\",\n \"KN\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KY\",\n \"KZ\",\n \"LA\",\n \"LB\",\n \"LC\",\n \"LI\",\n \"LK\",\n \"LR\",\n \"LS\",\n \"LT\",\n \"LU\",\n \"LV\",\n \"LY\",\n \"MA\",\n \"MC\",\n \"MD\",\n \"ME\",\n \"MF\",\n \"MG\",\n \"MH\",\n \"MK\",\n \"ML\",\n \"MM\",\n \"MN\",\n \"MO\",\n \"MP\",\n \"MQ\",\n \"MR\",\n \"MS\",\n \"MT\",\n \"MU\",\n \"MV\",\n \"MW\",\n \"MX\",\n \"MY\",\n \"MZ\",\n \"NA\",\n \"NC\",\n \"NE\",\n \"NF\",\n \"NG\",\n \"NI\",\n \"NL\",\n \"NO\",\n \"NP\",\n \"NR\",\n \"NU\",\n \"NZ\",\n \"OM\",\n \"PA\",\n \"PE\",\n \"PF\",\n \"PG\",\n \"PH\",\n \"PK\",\n \"PL\",\n \"PM\",\n \"PN\",\n \"PR\",\n \"PS\",\n \"PT\",\n \"PW\",\n \"PY\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RS\",\n \"RU\",\n \"RW\",\n \"SA\",\n \"SB\",\n \"SC\",\n \"SD\",\n \"SE\",\n \"SG\",\n \"SH\",\n \"SI\",\n \"SJ\",\n \"SK\",\n \"SL\",\n \"SM\",\n \"SN\",\n \"SO\",\n \"SR\",\n \"SS\",\n \"ST\",\n \"SV\",\n \"SX\",\n \"SY\",\n \"SZ\",\n \"TC\",\n \"TD\",\n \"TF\",\n \"TG\",\n \"TH\",\n \"TJ\",\n \"TK\",\n \"TL\",\n \"TM\",\n \"TN\",\n \"TO\",\n \"TR\",\n \"TT\",\n \"TV\",\n \"TW\",\n \"TZ\",\n \"UA\",\n \"UG\",\n \"UM\",\n \"US\",\n \"UY\",\n \"UZ\",\n \"VA\",\n \"VC\",\n \"VE\",\n \"VG\",\n \"VI\",\n \"VN\",\n \"VU\",\n \"WF\",\n \"WS\",\n \"YE\",\n \"YT\",\n \"ZA\",\n \"ZM\",\n \"ZW\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ZZ\",\n \"description\": \"Unknown\"\n },\n {\n \"name\": \"AD\",\n \"description\": \"Andorra\"\n },\n {\n \"name\": \"AE\",\n \"description\": \"United Arab Emirates\"\n },\n {\n \"name\": \"AF\",\n \"description\": \"Afghanistan\"\n },\n {\n \"name\": \"AG\",\n \"description\": \"Antigua and Barbuda\"\n },\n {\n \"name\": \"AI\",\n \"description\": \"Anguilla\"\n },\n {\n \"name\": \"AL\",\n \"description\": \"Albania\"\n },\n {\n \"name\": \"AM\",\n \"description\": \"Armenia\"\n },\n {\n \"name\": \"AO\",\n \"description\": \"Angola\"\n },\n {\n \"name\": \"AQ\",\n \"description\": \"Antartica\"\n },\n {\n \"name\": \"AR\",\n \"description\": \"Argentina\"\n },\n {\n \"name\": \"AS\",\n \"description\": \"American Samoa\"\n },\n {\n \"name\": \"AT\",\n \"description\": \"Austria\"\n },\n {\n \"name\": \"AU\",\n \"description\": \"Australia\"\n },\n {\n \"name\": \"AW\",\n \"description\": \"Aruba\"\n },\n {\n \"name\": \"AX\",\n \"description\": \"\\u00c5land Islands\"\n },\n {\n \"name\": \"AZ\",\n \"description\": \"Azerbaijan\"\n },\n {\n \"name\": \"BA\",\n \"description\": \"Bosnia and Herzegovina\"\n },\n {\n \"name\": \"BB\",\n \"description\": \"Barbados\"\n },\n {\n \"name\": \"BD\",\n \"description\": \"Bangladesh\"\n },\n {\n \"name\": \"BE\",\n \"description\": \"Belgium\"\n },\n {\n \"name\": \"BF\",\n \"description\": \"Burkina Faso\"\n },\n {\n \"name\": \"BG\",\n \"description\": \"Bulgaria\"\n },\n {\n \"name\": \"BH\",\n \"description\": \"Bahrain\"\n },\n {\n \"name\": \"BI\",\n \"description\": \"Burundi\"\n },\n {\n \"name\": \"BJ\",\n \"description\": \"Benin\"\n },\n {\n \"name\": \"BL\",\n \"description\": \"Saint Barth\\u00e9lemy\"\n },\n {\n \"name\": \"BM\",\n \"description\": \"Bermuda\"\n },\n {\n \"name\": \"BN\",\n \"description\": \"Brunei\"\n },\n {\n \"name\": \"BO\",\n \"description\": \"Bolivia\"\n },\n {\n \"name\": \"BQ\",\n \"description\": \"Bonaire\"\n },\n {\n \"name\": \"BR\",\n \"description\": \"Brazil\"\n },\n {\n \"name\": \"BS\",\n \"description\": \"Bahamas\"\n },\n {\n \"name\": \"BT\",\n \"description\": \"Bhutan\"\n },\n {\n \"name\": \"BV\",\n \"description\": \"Bouvet Island\"\n },\n {\n \"name\": \"BW\",\n \"description\": \"Botswana\"\n },\n {\n \"name\": \"BY\",\n \"description\": \"Belarus\"\n },\n {\n \"name\": \"BZ\",\n \"description\": \"Belize\"\n },\n {\n \"name\": \"CA\",\n \"description\": \"Canada\"\n },\n {\n \"name\": \"CC\",\n \"description\": \"Cocos Islands\"\n },\n {\n \"name\": \"CD\",\n \"description\": \"Democratic Republic of the Congo\"\n },\n {\n \"name\": \"CF\",\n \"description\": \"Central African Republic\"\n },\n {\n \"name\": \"CG\",\n \"description\": \"Congo\"\n },\n {\n \"name\": \"CH\",\n \"description\": \"Switzerland\"\n },\n {\n \"name\": \"CI\",\n \"description\": \"Ivory Coast\"\n },\n {\n \"name\": \"CK\",\n \"description\": \"Cook Islands\"\n },\n {\n \"name\": \"CL\",\n \"description\": \"Chile\"\n },\n {\n \"name\": \"CM\",\n \"description\": \"Cameroon\"\n },\n {\n \"name\": \"CN\",\n \"description\": \"China\"\n },\n {\n \"name\": \"CO\",\n \"description\": \"Colombia\"\n },\n {\n \"name\": \"CR\",\n \"description\": \"Costa Rica\"\n },\n {\n \"name\": \"CU\",\n \"description\": \"Cuba\"\n },\n {\n \"name\": \"CV\",\n \"description\": \"Cabo Verde\"\n },\n {\n \"name\": \"CW\",\n \"description\": \"Cura\\u00e7ao\"\n },\n {\n \"name\": \"CX\",\n \"description\": \"Christmas Island\"\n },\n {\n \"name\": \"CY\",\n \"description\": \"Cyprus\"\n },\n {\n \"name\": \"CZ\",\n \"description\": \"Czechia\"\n },\n {\n \"name\": \"DE\",\n \"description\": \"Germany\"\n },\n {\n \"name\": \"DJ\",\n \"description\": \"Djibouti\"\n },\n {\n \"name\": \"DK\",\n \"description\": \"Denmark\"\n },\n {\n \"name\": \"DM\",\n \"description\": \"Dominica\"\n },\n {\n \"name\": \"DO\",\n \"description\": \"Dominican Republic\"\n },\n {\n \"name\": \"DZ\",\n \"description\": \"Algeria\"\n },\n {\n \"name\": \"EC\",\n \"description\": \"Ecuador\"\n },\n {\n \"name\": \"EE\",\n \"description\": \"Estonia\"\n },\n {\n \"name\": \"EG\",\n \"description\": \"Egypt\"\n },\n {\n \"name\": \"EH\",\n \"description\": \"Western Sahara\"\n },\n {\n \"name\": \"ER\",\n \"description\": \"Eritrea\"\n },\n {\n \"name\": \"ES\",\n \"description\": \"Spain\"\n },\n {\n \"name\": \"ET\",\n \"description\": \"Ethiopia\"\n },\n {\n \"name\": \"FI\",\n \"description\": \"Finland\"\n },\n {\n \"name\": \"FJ\",\n \"description\": \"Fiji\"\n },\n {\n \"name\": \"FK\",\n \"description\": \"Falkland Islands\"\n },\n {\n \"name\": \"FM\",\n \"description\": \"Federated States of Micronesia\"\n },\n {\n \"name\": \"FO\",\n \"description\": \"Faroe Islands\"\n },\n {\n \"name\": \"FR\",\n \"description\": \"France\"\n },\n {\n \"name\": \"GA\",\n \"description\": \"Gabon\"\n },\n {\n \"name\": \"GB\",\n \"description\": \"United Kingdom\"\n },\n {\n \"name\": \"GD\",\n \"description\": \"Grenada\"\n },\n {\n \"name\": \"GE\",\n \"description\": \"Georgia\"\n },\n {\n \"name\": \"GF\",\n \"description\": \"French Guiana\"\n },\n {\n \"name\": \"GG\",\n \"description\": \"Guernsey\"\n },\n {\n \"name\": \"GH\",\n \"description\": \"Ghana\"\n },\n {\n \"name\": \"GI\",\n \"description\": \"Gibraltar\"\n },\n {\n \"name\": \"GL\",\n \"description\": \"Greenland\"\n },\n {\n \"name\": \"GM\",\n \"description\": \"Gambia\"\n },\n {\n \"name\": \"GN\",\n \"description\": \"Guinea\"\n },\n {\n \"name\": \"GP\",\n \"description\": \"Guadeloupe\"\n },\n {\n \"name\": \"GQ\",\n \"description\": \"Equatorial Guinea\"\n },\n {\n \"name\": \"GR\",\n \"description\": \"Greece\"\n },\n {\n \"name\": \"GS\",\n \"description\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"name\": \"GT\",\n \"description\": \"Guatemala\"\n },\n {\n \"name\": \"GU\",\n \"description\": \"Guam\"\n },\n {\n \"name\": \"GW\",\n \"description\": \"Guinea-Bissau\"\n },\n {\n \"name\": \"GY\",\n \"description\": \"Guyana\"\n },\n {\n \"name\": \"HK\",\n \"description\": \"Hong Kong\"\n },\n {\n \"name\": \"HM\",\n \"description\": \"Heard Island and McDonald Islands\"\n },\n {\n \"name\": \"HN\",\n \"description\": \"Honduras\"\n },\n {\n \"name\": \"HR\",\n \"description\": \"Croatia\"\n },\n {\n \"name\": \"HT\",\n \"description\": \"Haiti\"\n },\n {\n \"name\": \"HU\",\n \"description\": \"Hungary\"\n },\n {\n \"name\": \"ID\",\n \"description\": \"Indonesia\"\n },\n {\n \"name\": \"IE\",\n \"description\": \"Ireland\"\n },\n {\n \"name\": \"IL\",\n \"description\": \"Israel\"\n },\n {\n \"name\": \"IM\",\n \"description\": \"Isle of Man\"\n },\n {\n \"name\": \"IN\",\n \"description\": \"India\"\n },\n {\n \"name\": \"IO\",\n \"description\": \"British Indian Ocean Territory\"\n },\n {\n \"name\": \"IQ\",\n \"description\": \"Iraq\"\n },\n {\n \"name\": \"IR\",\n \"description\": \"Iran\"\n },\n {\n \"name\": \"IS\",\n \"description\": \"Iceland\"\n },\n {\n \"name\": \"IT\",\n \"description\": \"Italy\"\n },\n {\n \"name\": \"JE\",\n \"description\": \"Jersey\"\n },\n {\n \"name\": \"JM\",\n \"description\": \"Jamaica\"\n },\n {\n \"name\": \"JO\",\n \"description\": \"Jordan\"\n },\n {\n \"name\": \"JP\",\n \"description\": \"Japan\"\n },\n {\n \"name\": \"KE\",\n \"description\": \"Kenya\"\n },\n {\n \"name\": \"KG\",\n \"description\": \"Kyrgyzstan\"\n },\n {\n \"name\": \"KH\",\n \"description\": \"Cambodia\"\n },\n {\n \"name\": \"KI\",\n \"description\": \"Kiribati\"\n },\n {\n \"name\": \"KM\",\n \"description\": \"Comoros\"\n },\n {\n \"name\": \"KN\",\n \"description\": \"Saint Kitts and Nevis\"\n },\n {\n \"name\": \"KP\",\n \"description\": \"Democratic People's Republic of Korea\"\n },\n {\n \"name\": \"KR\",\n \"description\": \"Republic of Korea\"\n },\n {\n \"name\": \"KW\",\n \"description\": \"Kuwait\"\n },\n {\n \"name\": \"KY\",\n \"description\": \"Cayman Islands\"\n },\n {\n \"name\": \"KZ\",\n \"description\": \"Kazakhstan\"\n },\n {\n \"name\": \"LA\",\n \"description\": \"Lao People's Democratic Republic\"\n },\n {\n \"name\": \"LB\",\n \"description\": \"Lebanon\"\n },\n {\n \"name\": \"LC\",\n \"description\": \"Saint Lucia\"\n },\n {\n \"name\": \"LI\",\n \"description\": \"Liechtenstein\"\n },\n {\n \"name\": \"LK\",\n \"description\": \"Sri Lanka\"\n },\n {\n \"name\": \"LR\",\n \"description\": \"Liberia\"\n },\n {\n \"name\": \"LS\",\n \"description\": \"Lesotho\"\n },\n {\n \"name\": \"LT\",\n \"description\": \"Lithuania\"\n },\n {\n \"name\": \"LU\",\n \"description\": \"Luxembourg\"\n },\n {\n \"name\": \"LV\",\n \"description\": \"Latvia\"\n },\n {\n \"name\": \"LY\",\n \"description\": \"Libya\"\n },\n {\n \"name\": \"MA\",\n \"description\": \"Morocco\"\n },\n {\n \"name\": \"MC\",\n \"description\": \"Monaco\"\n },\n {\n \"name\": \"MD\",\n \"description\": \"Moldova\"\n },\n {\n \"name\": \"ME\",\n \"description\": \"Montenegro\"\n },\n {\n \"name\": \"MF\",\n \"description\": \"Saint Martin\"\n },\n {\n \"name\": \"MG\",\n \"description\": \"Madagascar\"\n },\n {\n \"name\": \"MH\",\n \"description\": \"Marshall Islands\"\n },\n {\n \"name\": \"MK\",\n \"description\": \"North Macedonia\"\n },\n {\n \"name\": \"ML\",\n \"description\": \"Mali\"\n },\n {\n \"name\": \"MM\",\n \"description\": \"Myanmar\"\n },\n {\n \"name\": \"MN\",\n \"description\": \"Mongolia\"\n },\n {\n \"name\": \"MO\",\n \"description\": \"Macao\"\n },\n {\n \"name\": \"MP\",\n \"description\": \"Northern Mariana Islands\"\n },\n {\n \"name\": \"MQ\",\n \"description\": \"Martinique\"\n },\n {\n \"name\": \"MR\",\n \"description\": \"Mauritania\"\n },\n {\n \"name\": \"MS\",\n \"description\": \"Montserrat\"\n },\n {\n \"name\": \"MT\",\n \"description\": \"Malta\"\n },\n {\n \"name\": \"MU\",\n \"description\": \"Mauritius\"\n },\n {\n \"name\": \"MV\",\n \"description\": \"Maldives\"\n },\n {\n \"name\": \"MW\",\n \"description\": \"Malawi\"\n },\n {\n \"name\": \"MX\",\n \"description\": \"Mexico\"\n },\n {\n \"name\": \"MY\",\n \"description\": \"Malaysia\"\n },\n {\n \"name\": \"MZ\",\n \"description\": \"Mozambique\"\n },\n {\n \"name\": \"NA\",\n \"description\": \"Namibia\"\n },\n {\n \"name\": \"NC\",\n \"description\": \"New Caledonia\"\n },\n {\n \"name\": \"NE\",\n \"description\": \"Niger\"\n },\n {\n \"name\": \"NF\",\n \"description\": \"Norfolk Island\"\n },\n {\n \"name\": \"NG\",\n \"description\": \"Nigeria\"\n },\n {\n \"name\": \"NI\",\n \"description\": \"Nicaragua\"\n },\n {\n \"name\": \"NL\",\n \"description\": \"Netherlands\"\n },\n {\n \"name\": \"NO\",\n \"description\": \"Norway\"\n },\n {\n \"name\": \"NP\",\n \"description\": \"Nepal\"\n },\n {\n \"name\": \"NR\",\n \"description\": \"Nauru\"\n },\n {\n \"name\": \"NU\",\n \"description\": \"Niue\"\n },\n {\n \"name\": \"NZ\",\n \"description\": \"New Zealand\"\n },\n {\n \"name\": \"OM\",\n \"description\": \"Oman\"\n },\n {\n \"name\": \"PA\",\n \"description\": \"Panama\"\n },\n {\n \"name\": \"PE\",\n \"description\": \"Peru\"\n },\n {\n \"name\": \"PF\",\n \"description\": \"French Polynesia\"\n },\n {\n \"name\": \"PG\",\n \"description\": \"Papua New Guinea\"\n },\n {\n \"name\": \"PH\",\n \"description\": \"Philippines\"\n },\n {\n \"name\": \"PK\",\n \"description\": \"Pakistan\"\n },\n {\n \"name\": \"PL\",\n \"description\": \"Poland\"\n },\n {\n \"name\": \"PM\",\n \"description\": \"Saint Pierre and Miquelon\"\n },\n {\n \"name\": \"PN\",\n \"description\": \"Pitcairn\"\n },\n {\n \"name\": \"PR\",\n \"description\": \"Puerto Rico\"\n },\n {\n \"name\": \"PS\",\n \"description\": \"Palestine\"\n },\n {\n \"name\": \"PT\",\n \"description\": \"Portugal\"\n },\n {\n \"name\": \"PW\",\n \"description\": \"Palau\"\n },\n {\n \"name\": \"PY\",\n \"description\": \"Paraguay\"\n },\n {\n \"name\": \"QA\",\n \"description\": \"Qatar\"\n },\n {\n \"name\": \"RE\",\n \"description\": \"R\\u00e9union\"\n },\n {\n \"name\": \"RO\",\n \"description\": \"Romania\"\n },\n {\n \"name\": \"RS\",\n \"description\": \"Serbia\"\n },\n {\n \"name\": \"RU\",\n \"description\": \"Russia\"\n },\n {\n \"name\": \"RW\",\n \"description\": \"Rwanda\"\n },\n {\n \"name\": \"SA\",\n \"description\": \"Saudi Arabia\"\n },\n {\n \"name\": \"SB\",\n \"description\": \"Solomon Islands\"\n },\n {\n \"name\": \"SC\",\n \"description\": \"Seychelles\"\n },\n {\n \"name\": \"SD\",\n \"description\": \"Sudan\"\n },\n {\n \"name\": \"SE\",\n \"description\": \"Sweden\"\n },\n {\n \"name\": \"SG\",\n \"description\": \"Singapore\"\n },\n {\n \"name\": \"SH\",\n \"description\": \"Saint Helena, Ascension and Tristan da Cunha\"\n },\n {\n \"name\": \"SI\",\n \"description\": \"Slovenia\"\n },\n {\n \"name\": \"SJ\",\n \"description\": \"Svalbard and Jan Mayen\"\n },\n {\n \"name\": \"SK\",\n \"description\": \"Slovakia\"\n },\n {\n \"name\": \"SL\",\n \"description\": \"Sierra Leone\"\n },\n {\n \"name\": \"SM\",\n \"description\": \"San Marino\"\n },\n {\n \"name\": \"SN\",\n \"description\": \"Senegal\"\n },\n {\n \"name\": \"SO\",\n \"description\": \"Somalia\"\n },\n {\n \"name\": \"SR\",\n \"description\": \"Suriname\"\n },\n {\n \"name\": \"SS\",\n \"description\": \"South Sudan\"\n },\n {\n \"name\": \"ST\",\n \"description\": \"Sao Tome and Principe\"\n },\n {\n \"name\": \"SV\",\n \"description\": \"El Salvador\"\n },\n {\n \"name\": \"SX\",\n \"description\": \"Sint Maarten\"\n },\n {\n \"name\": \"SY\",\n \"description\": \"Syrian Arab Republic\"\n },\n {\n \"name\": \"SZ\",\n \"description\": \"Eswatini\"\n },\n {\n \"name\": \"TC\",\n \"description\": \"Turks and Caicos Islands\"\n },\n {\n \"name\": \"TD\",\n \"description\": \"Chad\"\n },\n {\n \"name\": \"TF\",\n \"description\": \"French Southern Territories\"\n },\n {\n \"name\": \"TG\",\n \"description\": \"Togo\"\n },\n {\n \"name\": \"TH\",\n \"description\": \"Thailand\"\n },\n {\n \"name\": \"TJ\",\n \"description\": \"Tajikistan\"\n },\n {\n \"name\": \"TK\",\n \"description\": \"Tokelau\"\n },\n {\n \"name\": \"TL\",\n \"description\": \"Timor-Leste\"\n },\n {\n \"name\": \"TM\",\n \"description\": \"Turkmenistan\"\n },\n {\n \"name\": \"TN\",\n \"description\": \"Tunisia\"\n },\n {\n \"name\": \"TO\",\n \"description\": \"Tonga\"\n },\n {\n \"name\": \"TR\",\n \"description\": \"Turkey\"\n },\n {\n \"name\": \"TT\",\n \"description\": \"Trinidad and Tobago\"\n },\n {\n \"name\": \"TV\",\n \"description\": \"Tuvalu\"\n },\n {\n \"name\": \"TW\",\n \"description\": \"Taiwan\"\n },\n {\n \"name\": \"TZ\",\n \"description\": \"Tanzania\"\n },\n {\n \"name\": \"UA\",\n \"description\": \"Ukraine\"\n },\n {\n \"name\": \"UG\",\n \"description\": \"Uganda\"\n },\n {\n \"name\": \"UM\",\n \"description\": \"United States Minor Outlying Islands\"\n },\n {\n \"name\": \"US\",\n \"description\": \"United States of America\"\n },\n {\n \"name\": \"UY\",\n \"description\": \"Uruguay\"\n },\n {\n \"name\": \"UZ\",\n \"description\": \"Uzbekistan\"\n },\n {\n \"name\": \"VA\",\n \"description\": \"Vatican City\"\n },\n {\n \"name\": \"VC\",\n \"description\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"name\": \"VE\",\n \"description\": \"Venezuela\"\n },\n {\n \"name\": \"VG\",\n \"description\": \"British Virgin Islands\"\n },\n {\n \"name\": \"VI\",\n \"description\": \"U.S. Virgin Islands\"\n },\n {\n \"name\": \"VN\",\n \"description\": \"Vietnam\"\n },\n {\n \"name\": \"VU\",\n \"description\": \"Vanuatu\"\n },\n {\n \"name\": \"WF\",\n \"description\": \"Wallis and Futuna\"\n },\n {\n \"name\": \"WS\",\n \"description\": \"Samoa\"\n },\n {\n \"name\": \"YE\",\n \"description\": \"Yemen\"\n },\n {\n \"name\": \"YT\",\n \"description\": \"Mayotte\"\n },\n {\n \"name\": \"ZA\",\n \"description\": \"South Africa\"\n },\n {\n \"name\": \"ZM\",\n \"description\": \"Zambia\"\n },\n {\n \"name\": \"ZW\",\n \"description\": \"Zimbabwe\"\n }\n ],\n \"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).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"first_name\": {\n \"type\": \"string\",\n \"description\": \"Optional first name when it's representing recipient.\",\n \"nullable\": true\n },\n \"last_name\": {\n \"type\": \"string\",\n \"description\": \"Optional last name when it's representing recipient.\",\n \"nullable\": true\n }\n }\n },\n \"fingerprint\": {\n \"type\": \"string\",\n \"description\": \"Intended as a Square-assigned identifier, based\\non the card number, to identify the card across multiple locations within a\\nsingle application.\",\n \"maxLength\": 255,\n \"readOnly\": true\n },\n \"customer_id\": {\n \"type\": \"string\",\n \"description\": \"**Required** The ID of a [customer](entity:Customer) to be associated with the card.\",\n \"nullable\": true\n },\n \"merchant_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the merchant associated with the card.\",\n \"readOnly\": true\n },\n \"reference_id\": {\n \"type\": \"string\",\n \"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.\",\n \"maxLength\": 128,\n \"nullable\": true\n },\n \"enabled\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether or not a card can be used for payments.\",\n \"readOnly\": true\n },\n \"card_type\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CARD_TYPE\",\n \"CREDIT\",\n \"DEBIT\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CARD_TYPE\",\n \"description\": \"\"\n },\n {\n \"name\": \"CREDIT\",\n \"description\": \"\"\n },\n {\n \"name\": \"DEBIT\",\n \"description\": \"\"\n }\n ],\n \"description\": \"Indicates a card's type, such as `CREDIT` or `DEBIT`.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"prepaid_type\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_PREPAID_TYPE\",\n \"NOT_PREPAID\",\n \"PREPAID\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_PREPAID_TYPE\",\n \"description\": \"\"\n },\n {\n \"name\": \"NOT_PREPAID\",\n \"description\": \"\"\n },\n {\n \"name\": \"PREPAID\",\n \"description\": \"\"\n }\n ],\n \"description\": \"Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"bin\": {\n \"type\": \"string\",\n \"description\": \"The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\\nreturns this field.\",\n \"maxLength\": 6,\n \"readOnly\": true\n },\n \"version\": {\n \"type\": \"integer\",\n \"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.\",\n \"format\": \"int64\"\n },\n \"card_co_brand\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN\",\n \"AFTERPAY\",\n \"CLEARPAY\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN\",\n \"description\": \"\"\n },\n {\n \"name\": \"AFTERPAY\",\n \"description\": \"\"\n },\n {\n \"name\": \"CLEARPAY\",\n \"description\": \"\"\n }\n ],\n \"description\": \"Indicates the brand for a co-branded card.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"issuer_alert\": {\n \"type\": \"string\",\n \"enum\": [\n \"ISSUER_ALERT_CARD_CLOSED\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ISSUER_ALERT_CARD_CLOSED\",\n \"description\": \"The underlying account of the card was closed, which is a strong signal that future\\ncharges to the card are likely to fail.\"\n }\n ],\n \"description\": \"Indicates the type of issuer alert for a [card on file](entity:Card).\",\n \"x-release-status\": \"BETA\"\n },\n \"issuer_alert_at\": {\n \"type\": \"string\",\n \"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.\",\n \"readOnly\": true,\n \"x-release-status\": \"BETA\"\n },\n \"hsa_fsa\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether the card is linked to a Health Savings Account (HSA) or Flexible\\nSpending Account (FSA), based on the card BIN.\",\n \"readOnly\": true,\n \"x-release-status\": \"BETA\"\n }\n }\n }\n },\n \"example\": {\n \"card\": {\n \"billing_address\": {\n \"address_line_1\": \"500 Electric Ave\",\n \"address_line_2\": \"Suite 600\",\n \"administrative_district_level_1\": \"NY\",\n \"country\": \"US\",\n \"locality\": \"New York\",\n \"postal_code\": \"10003\"\n },\n \"cardholder_name\": \"Amelia Earhart\",\n \"customer_id\": \"VDKXEEKPJN48QDG3BGGFAK05P8\",\n \"reference_id\": \"user-id-1\"\n },\n \"idempotency_key\": \"4935a656-a929-4792-b97c-8848be85c27c\",\n \"source_id\": \"cnon:uIbfJXhXETSP197M3GB\"\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}
Reference in a new issue View git blame Copy permalink