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/CreateGiftCard.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

713 lines
68 KiB
JSON
Raw Blame History

{
"name": "CreateGiftCard",
"fully_qualified_name": "SquareupApi.CreateGiftCard@2.0.0",
"description": "Create and register digital or physical gift cards.\n\nThis tool creates a digital or registers a physical gift card in a pending state. To activate the gift card for purchases, further action is needed using CreateGiftCardActivity for activation or RefundPayment for refunds.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "gift_card_request_body",
"required": true,
"description": "JSON object with information required to create or register a gift card, including type, balance, and location.",
"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 identifier for this request, used to ensure idempotency. For more information, \nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
},
"location_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"gift_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": "The Square-assigned ID of the gift card."
},
"type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"PHYSICAL",
"DIGITAL"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the gift card type."
},
"gan_source": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"SQUARE",
"OTHER"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the source that generated the gift card \naccount number (GAN)."
},
"state": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ACTIVE",
"DEACTIVATED",
"BLOCKED",
"PENDING"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the gift card state."
},
"balance_money": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"amount": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
},
"currency": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_CURRENCY",
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SLE",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMK",
"ZMW",
"BTC",
"XUS"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)."
}
},
"inner_properties": null,
"description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information."
},
"gan": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The gift card account number (GAN). Buyers can use the GAN to make purchases or check \nthe gift card balance."
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"customer_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked."
}
},
"inner_properties": null,
"description": "Represents a Square gift card."
}
},
"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 'CreateGiftCard'.",
"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": {
"scopes": [
"GIFTCARDS_WRITE"
]
}
},
"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/gift-cards",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "requestBody",
"tool_parameter_name": "gift_card_request_body",
"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 identifier for this request, used to ensure idempotency. For more information, \nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
},
"location_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"gift_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": "The Square-assigned ID of the gift card."
},
"type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"PHYSICAL",
"DIGITAL"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the gift card type."
},
"gan_source": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"SQUARE",
"OTHER"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the source that generated the gift card \naccount number (GAN)."
},
"state": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ACTIVE",
"DEACTIVATED",
"BLOCKED",
"PENDING"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the gift card state."
},
"balance_money": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"amount": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
},
"currency": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"UNKNOWN_CURRENCY",
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SLE",
"SOS",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"USS",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"XXX",
"YER",
"ZAR",
"ZMK",
"ZMW",
"BTC",
"XUS"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217)."
}
},
"inner_properties": null,
"description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information."
},
"gan": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The gift card account number (GAN). Buyers can use the GAN to make purchases or check \nthe gift card balance."
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"customer_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked."
}
},
"inner_properties": null,
"description": "Represents a Square gift card."
}
},
"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\": \"Represents a [CreateGiftCard](api-endpoint:GiftCards-CreateGiftCard) request.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"idempotency_key\",\n \"location_id\",\n \"gift_card\"\n ],\n \"properties\": {\n \"idempotency_key\": {\n \"type\": \"string\",\n \"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).\",\n \"minLength\": 1,\n \"maxLength\": 128\n },\n \"location_id\": {\n \"type\": \"string\",\n \"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.\",\n \"minLength\": 1\n },\n \"gift_card\": {\n \"type\": \"object\",\n \"description\": \"Represents a Square gift card.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"type\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The Square-assigned ID of the gift card.\",\n \"readOnly\": true\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"PHYSICAL\",\n \"DIGITAL\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"PHYSICAL\",\n \"description\": \"A plastic gift card.\"\n },\n {\n \"name\": \"DIGITAL\",\n \"description\": \"A digital gift card.\"\n }\n ],\n \"description\": \"Indicates the gift card type.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"gan_source\": {\n \"type\": \"string\",\n \"enum\": [\n \"SQUARE\",\n \"OTHER\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"SQUARE\",\n \"description\": \"The GAN is generated by Square.\"\n },\n {\n \"name\": \"OTHER\",\n \"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).\"\n }\n ],\n \"description\": \"Indicates the source that generated the gift card \\naccount number (GAN).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"state\": {\n \"type\": \"string\",\n \"enum\": [\n \"ACTIVE\",\n \"DEACTIVATED\",\n \"BLOCKED\",\n \"PENDING\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ACTIVE\",\n \"description\": \"The gift card is active and can be used as a payment source.\"\n },\n {\n \"name\": \"DEACTIVATED\",\n \"description\": \"Any activity that changes the gift card balance is permanently forbidden.\"\n },\n {\n \"name\": \"BLOCKED\",\n \"description\": \"Any activity that changes the gift card balance is temporarily forbidden.\"\n },\n {\n \"name\": \"PENDING\",\n \"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.\"\n }\n ],\n \"description\": \"Indicates the gift card state.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"balance_money\": {\n \"type\": \"object\",\n \"description\": \"Represents an amount of money. `Money` fields can be signed or unsigned.\\nFields that do not explicitly define whether they are signed or unsigned are\\nconsidered unsigned and can only hold positive amounts. For signed fields, the\\nsign of the value indicates the purpose of the money transfer. See\\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\\nfor more information.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"amount\": {\n \"type\": \"integer\",\n \"description\": \"The amount of money, in the smallest denomination of the currency\\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\\nin cents. Monetary amounts can be positive or negative. See the specific\\nfield description to determine the meaning of the sign in a particular case.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"currency\": {\n \"type\": \"string\",\n \"enum\": [\n \"UNKNOWN_CURRENCY\",\n \"AED\",\n \"AFN\",\n \"ALL\",\n \"AMD\",\n \"ANG\",\n \"AOA\",\n \"ARS\",\n \"AUD\",\n \"AWG\",\n \"AZN\",\n \"BAM\",\n \"BBD\",\n \"BDT\",\n \"BGN\",\n \"BHD\",\n \"BIF\",\n \"BMD\",\n \"BND\",\n \"BOB\",\n \"BOV\",\n \"BRL\",\n \"BSD\",\n \"BTN\",\n \"BWP\",\n \"BYR\",\n \"BZD\",\n \"CAD\",\n \"CDF\",\n \"CHE\",\n \"CHF\",\n \"CHW\",\n \"CLF\",\n \"CLP\",\n \"CNY\",\n \"COP\",\n \"COU\",\n \"CRC\",\n \"CUC\",\n \"CUP\",\n \"CVE\",\n \"CZK\",\n \"DJF\",\n \"DKK\",\n \"DOP\",\n \"DZD\",\n \"EGP\",\n \"ERN\",\n \"ETB\",\n \"EUR\",\n \"FJD\",\n \"FKP\",\n \"GBP\",\n \"GEL\",\n \"GHS\",\n \"GIP\",\n \"GMD\",\n \"GNF\",\n \"GTQ\",\n \"GYD\",\n \"HKD\",\n \"HNL\",\n \"HRK\",\n \"HTG\",\n \"HUF\",\n \"IDR\",\n \"ILS\",\n \"INR\",\n \"IQD\",\n \"IRR\",\n \"ISK\",\n \"JMD\",\n \"JOD\",\n \"JPY\",\n \"KES\",\n \"KGS\",\n \"KHR\",\n \"KMF\",\n \"KPW\",\n \"KRW\",\n \"KWD\",\n \"KYD\",\n \"KZT\",\n \"LAK\",\n \"LBP\",\n \"LKR\",\n \"LRD\",\n \"LSL\",\n \"LTL\",\n \"LVL\",\n \"LYD\",\n \"MAD\",\n \"MDL\",\n \"MGA\",\n \"MKD\",\n \"MMK\",\n \"MNT\",\n \"MOP\",\n \"MRO\",\n \"MUR\",\n \"MVR\",\n \"MWK\",\n \"MXN\",\n \"MXV\",\n \"MYR\",\n \"MZN\",\n \"NAD\",\n \"NGN\",\n \"NIO\",\n \"NOK\",\n \"NPR\",\n \"NZD\",\n \"OMR\",\n \"PAB\",\n \"PEN\",\n \"PGK\",\n \"PHP\",\n \"PKR\",\n \"PLN\",\n \"PYG\",\n \"QAR\",\n \"RON\",\n \"RSD\",\n \"RUB\",\n \"RWF\",\n \"SAR\",\n \"SBD\",\n \"SCR\",\n \"SDG\",\n \"SEK\",\n \"SGD\",\n \"SHP\",\n \"SLL\",\n \"SLE\",\n \"SOS\",\n \"SRD\",\n \"SSP\",\n \"STD\",\n \"SVC\",\n \"SYP\",\n \"SZL\",\n \"THB\",\n \"TJS\",\n \"TMT\",\n \"TND\",\n \"TOP\",\n \"TRY\",\n \"TTD\",\n \"TWD\",\n \"TZS\",\n \"UAH\",\n \"UGX\",\n \"USD\",\n \"USN\",\n \"USS\",\n \"UYI\",\n \"UYU\",\n \"UZS\",\n \"VEF\",\n \"VND\",\n \"VUV\",\n \"WST\",\n \"XAF\",\n \"XAG\",\n \"XAU\",\n \"XBA\",\n \"XBB\",\n \"XBC\",\n \"XBD\",\n \"XCD\",\n \"XDR\",\n \"XOF\",\n \"XPD\",\n \"XPF\",\n \"XPT\",\n \"XTS\",\n \"XXX\",\n \"YER\",\n \"ZAR\",\n \"ZMK\",\n \"ZMW\",\n \"BTC\",\n \"XUS\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"UNKNOWN_CURRENCY\",\n \"description\": \"Unknown currency\"\n },\n {\n \"name\": \"AED\",\n \"description\": \"United Arab Emirates dirham\"\n },\n {\n \"name\": \"AFN\",\n \"description\": \"Afghan afghani\"\n },\n {\n \"name\": \"ALL\",\n \"description\": \"Albanian lek\"\n },\n {\n \"name\": \"AMD\",\n \"description\": \"Armenian dram\"\n },\n {\n \"name\": \"ANG\",\n \"description\": \"Netherlands Antillean guilder\"\n },\n {\n \"name\": \"AOA\",\n \"description\": \"Angolan kwanza\"\n },\n {\n \"name\": \"ARS\",\n \"description\": \"Argentine peso\"\n },\n {\n \"name\": \"AUD\",\n \"description\": \"Australian dollar\"\n },\n {\n \"name\": \"AWG\",\n \"description\": \"Aruban florin\"\n },\n {\n \"name\": \"AZN\",\n \"description\": \"Azerbaijani manat\"\n },\n {\n \"name\": \"BAM\",\n \"description\": \"Bosnia and Herzegovina convertible mark\"\n },\n {\n \"name\": \"BBD\",\n \"description\": \"Barbados dollar\"\n },\n {\n \"name\": \"BDT\",\n \"description\": \"Bangladeshi taka\"\n },\n {\n \"name\": \"BGN\",\n \"description\": \"Bulgarian lev\"\n },\n {\n \"name\": \"BHD\",\n \"description\": \"Bahraini dinar\"\n },\n {\n \"name\": \"BIF\",\n \"description\": \"Burundian franc\"\n },\n {\n \"name\": \"BMD\",\n \"description\": \"Bermudian dollar\"\n },\n {\n \"name\": \"BND\",\n \"description\": \"Brunei dollar\"\n },\n {\n \"name\": \"BOB\",\n \"description\": \"Boliviano\"\n },\n {\n \"name\": \"BOV\",\n \"description\": \"Bolivian Mvdol\"\n },\n {\n \"name\": \"BRL\",\n \"description\": \"Brazilian real\"\n },\n {\n \"name\": \"BSD\",\n \"description\": \"Bahamian dollar\"\n },\n {\n \"name\": \"BTN\",\n \"description\": \"Bhutanese ngultrum\"\n },\n {\n \"name\": \"BWP\",\n \"description\": \"Botswana pula\"\n },\n {\n \"name\": \"BYR\",\n \"description\": \"Belarusian ruble\"\n },\n {\n \"name\": \"BZD\",\n \"description\": \"Belize dollar\"\n },\n {\n \"name\": \"CAD\",\n \"description\": \"Canadian dollar\"\n },\n {\n \"name\": \"CDF\",\n \"description\": \"Congolese franc\"\n },\n {\n \"name\": \"CHE\",\n \"description\": \"WIR Euro\"\n },\n {\n \"name\": \"CHF\",\n \"description\": \"Swiss franc\"\n },\n {\n \"name\": \"CHW\",\n \"description\": \"WIR Franc\"\n },\n {\n \"name\": \"CLF\",\n \"description\": \"Unidad de Fomento\"\n },\n {\n \"name\": \"CLP\",\n \"description\": \"Chilean peso\"\n },\n {\n \"name\": \"CNY\",\n \"description\": \"Chinese yuan\"\n },\n {\n \"name\": \"COP\",\n \"description\": \"Colombian peso\"\n },\n {\n \"name\": \"COU\",\n \"description\": \"Unidad de Valor Real\"\n },\n {\n \"name\": \"CRC\",\n \"description\": \"Costa Rican colon\"\n },\n {\n \"name\": \"CUC\",\n \"description\": \"Cuban convertible peso\"\n },\n {\n \"name\": \"CUP\",\n \"description\": \"Cuban peso\"\n },\n {\n \"name\": \"CVE\",\n \"description\": \"Cape Verdean escudo\"\n },\n {\n \"name\": \"CZK\",\n \"description\": \"Czech koruna\"\n },\n {\n \"name\": \"DJF\",\n \"description\": \"Djiboutian franc\"\n },\n {\n \"name\": \"DKK\",\n \"description\": \"Danish krone\"\n },\n {\n \"name\": \"DOP\",\n \"description\": \"Dominican peso\"\n },\n {\n \"name\": \"DZD\",\n \"description\": \"Algerian dinar\"\n },\n {\n \"name\": \"EGP\",\n \"description\": \"Egyptian pound\"\n },\n {\n \"name\": \"ERN\",\n \"description\": \"Eritrean nakfa\"\n },\n {\n \"name\": \"ETB\",\n \"description\": \"Ethiopian birr\"\n },\n {\n \"name\": \"EUR\",\n \"description\": \"Euro\"\n },\n {\n \"name\": \"FJD\",\n \"description\": \"Fiji dollar\"\n },\n {\n \"name\": \"FKP\",\n \"description\": \"Falkland Islands pound\"\n },\n {\n \"name\": \"GBP\",\n \"description\": \"Pound sterling\"\n },\n {\n \"name\": \"GEL\",\n \"description\": \"Georgian lari\"\n },\n {\n \"name\": \"GHS\",\n \"description\": \"Ghanaian cedi\"\n },\n {\n \"name\": \"GIP\",\n \"description\": \"Gibraltar pound\"\n },\n {\n \"name\": \"GMD\",\n \"description\": \"Gambian dalasi\"\n },\n {\n \"name\": \"GNF\",\n \"description\": \"Guinean franc\"\n },\n {\n \"name\": \"GTQ\",\n \"description\": \"Guatemalan quetzal\"\n },\n {\n \"name\": \"GYD\",\n \"description\": \"Guyanese dollar\"\n },\n {\n \"name\": \"HKD\",\n \"description\": \"Hong Kong dollar\"\n },\n {\n \"name\": \"HNL\",\n \"description\": \"Honduran lempira\"\n },\n {\n \"name\": \"HRK\",\n \"description\": \"Croatian kuna\"\n },\n {\n \"name\": \"HTG\",\n \"description\": \"Haitian gourde\"\n },\n {\n \"name\": \"HUF\",\n \"description\": \"Hungarian forint\"\n },\n {\n \"name\": \"IDR\",\n \"description\": \"Indonesian rupiah\"\n },\n {\n \"name\": \"ILS\",\n \"description\": \"Israeli new shekel\"\n },\n {\n \"name\": \"INR\",\n \"description\": \"Indian rupee\"\n },\n {\n \"name\": \"IQD\",\n \"description\": \"Iraqi dinar\"\n },\n {\n \"name\": \"IRR\",\n \"description\": \"Iranian rial\"\n },\n {\n \"name\": \"ISK\",\n \"description\": \"Icelandic kr\\u00f3na\"\n },\n {\n \"name\": \"JMD\",\n \"description\": \"Jamaican dollar\"\n },\n {\n \"name\": \"JOD\",\n \"description\": \"Jordanian dinar\"\n },\n {\n \"name\": \"JPY\",\n \"description\": \"Japanese yen\"\n },\n {\n \"name\": \"KES\",\n \"description\": \"Kenyan shilling\"\n },\n {\n \"name\": \"KGS\",\n \"description\": \"Kyrgyzstani som\"\n },\n {\n \"name\": \"KHR\",\n \"description\": \"Cambodian riel\"\n },\n {\n \"name\": \"KMF\",\n \"description\": \"Comoro franc\"\n },\n {\n \"name\": \"KPW\",\n \"description\": \"North Korean won\"\n },\n {\n \"name\": \"KRW\",\n \"description\": \"South Korean won\"\n },\n {\n \"name\": \"KWD\",\n \"description\": \"Kuwaiti dinar\"\n },\n {\n \"name\": \"KYD\",\n \"description\": \"Cayman Islands dollar\"\n },\n {\n \"name\": \"KZT\",\n \"description\": \"Kazakhstani tenge\"\n },\n {\n \"name\": \"LAK\",\n \"description\": \"Lao kip\"\n },\n {\n \"name\": \"LBP\",\n \"description\": \"Lebanese pound\"\n },\n {\n \"name\": \"LKR\",\n \"description\": \"Sri Lankan rupee\"\n },\n {\n \"name\": \"LRD\",\n \"description\": \"Liberian dollar\"\n },\n {\n \"name\": \"LSL\",\n \"description\": \"Lesotho loti\"\n },\n {\n \"name\": \"LTL\",\n \"description\": \"Lithuanian litas\"\n },\n {\n \"name\": \"LVL\",\n \"description\": \"Latvian lats\"\n },\n {\n \"name\": \"LYD\",\n \"description\": \"Libyan dinar\"\n },\n {\n \"name\": \"MAD\",\n \"description\": \"Moroccan dirham\"\n },\n {\n \"name\": \"MDL\",\n \"description\": \"Moldovan leu\"\n },\n {\n \"name\": \"MGA\",\n \"description\": \"Malagasy ariary\"\n },\n {\n \"name\": \"MKD\",\n \"description\": \"Macedonian denar\"\n },\n {\n \"name\": \"MMK\",\n \"description\": \"Myanmar kyat\"\n },\n {\n \"name\": \"MNT\",\n \"description\": \"Mongolian t\\u00f6gr\\u00f6g\"\n },\n {\n \"name\": \"MOP\",\n \"description\": \"Macanese pataca\"\n },\n {\n \"name\": \"MRO\",\n \"description\": \"Mauritanian ouguiya\"\n },\n {\n \"name\": \"MUR\",\n \"description\": \"Mauritian rupee\"\n },\n {\n \"name\": \"MVR\",\n \"description\": \"Maldivian rufiyaa\"\n },\n {\n \"name\": \"MWK\",\n \"description\": \"Malawian kwacha\"\n },\n {\n \"name\": \"MXN\",\n \"description\": \"Mexican peso\"\n },\n {\n \"name\": \"MXV\",\n \"description\": \"Mexican Unidad de Inversion\"\n },\n {\n \"name\": \"MYR\",\n \"description\": \"Malaysian ringgit\"\n },\n {\n \"name\": \"MZN\",\n \"description\": \"Mozambican metical\"\n },\n {\n \"name\": \"NAD\",\n \"description\": \"Namibian dollar\"\n },\n {\n \"name\": \"NGN\",\n \"description\": \"Nigerian naira\"\n },\n {\n \"name\": \"NIO\",\n \"description\": \"Nicaraguan c\\u00f3rdoba\"\n },\n {\n \"name\": \"NOK\",\n \"description\": \"Norwegian krone\"\n },\n {\n \"name\": \"NPR\",\n \"description\": \"Nepalese rupee\"\n },\n {\n \"name\": \"NZD\",\n \"description\": \"New Zealand dollar\"\n },\n {\n \"name\": \"OMR\",\n \"description\": \"Omani rial\"\n },\n {\n \"name\": \"PAB\",\n \"description\": \"Panamanian balboa\"\n },\n {\n \"name\": \"PEN\",\n \"description\": \"Peruvian sol\"\n },\n {\n \"name\": \"PGK\",\n \"description\": \"Papua New Guinean kina\"\n },\n {\n \"name\": \"PHP\",\n \"description\": \"Philippine peso\"\n },\n {\n \"name\": \"PKR\",\n \"description\": \"Pakistani rupee\"\n },\n {\n \"name\": \"PLN\",\n \"description\": \"Polish z\\u0142oty\"\n },\n {\n \"name\": \"PYG\",\n \"description\": \"Paraguayan guaran\\u00ed\"\n },\n {\n \"name\": \"QAR\",\n \"description\": \"Qatari riyal\"\n },\n {\n \"name\": \"RON\",\n \"description\": \"Romanian leu\"\n },\n {\n \"name\": \"RSD\",\n \"description\": \"Serbian dinar\"\n },\n {\n \"name\": \"RUB\",\n \"description\": \"Russian ruble\"\n },\n {\n \"name\": \"RWF\",\n \"description\": \"Rwandan franc\"\n },\n {\n \"name\": \"SAR\",\n \"description\": \"Saudi riyal\"\n },\n {\n \"name\": \"SBD\",\n \"description\": \"Solomon Islands dollar\"\n },\n {\n \"name\": \"SCR\",\n \"description\": \"Seychelles rupee\"\n },\n {\n \"name\": \"SDG\",\n \"description\": \"Sudanese pound\"\n },\n {\n \"name\": \"SEK\",\n \"description\": \"Swedish krona\"\n },\n {\n \"name\": \"SGD\",\n \"description\": \"Singapore dollar\"\n },\n {\n \"name\": \"SHP\",\n \"description\": \"Saint Helena pound\"\n },\n {\n \"name\": \"SLL\",\n \"description\": \"Sierra Leonean first leone\"\n },\n {\n \"name\": \"SLE\",\n \"description\": \"Sierra Leonean second leone\"\n },\n {\n \"name\": \"SOS\",\n \"description\": \"Somali shilling\"\n },\n {\n \"name\": \"SRD\",\n \"description\": \"Surinamese dollar\"\n },\n {\n \"name\": \"SSP\",\n \"description\": \"South Sudanese pound\"\n },\n {\n \"name\": \"STD\",\n \"description\": \"S\\u00e3o Tom\\u00e9 and Pr\\u00edncipe dobra\"\n },\n {\n \"name\": \"SVC\",\n \"description\": \"Salvadoran col\\u00f3n\"\n },\n {\n \"name\": \"SYP\",\n \"description\": \"Syrian pound\"\n },\n {\n \"name\": \"SZL\",\n \"description\": \"Swazi lilangeni\"\n },\n {\n \"name\": \"THB\",\n \"description\": \"Thai baht\"\n },\n {\n \"name\": \"TJS\",\n \"description\": \"Tajikstani somoni\"\n },\n {\n \"name\": \"TMT\",\n \"description\": \"Turkmenistan manat\"\n },\n {\n \"name\": \"TND\",\n \"description\": \"Tunisian dinar\"\n },\n {\n \"name\": \"TOP\",\n \"description\": \"Tongan pa'anga\"\n },\n {\n \"name\": \"TRY\",\n \"description\": \"Turkish lira\"\n },\n {\n \"name\": \"TTD\",\n \"description\": \"Trinidad and Tobago dollar\"\n },\n {\n \"name\": \"TWD\",\n \"description\": \"New Taiwan dollar\"\n },\n {\n \"name\": \"TZS\",\n \"description\": \"Tanzanian shilling\"\n },\n {\n \"name\": \"UAH\",\n \"description\": \"Ukrainian hryvnia\"\n },\n {\n \"name\": \"UGX\",\n \"description\": \"Ugandan shilling\"\n },\n {\n \"name\": \"USD\",\n \"description\": \"United States dollar\"\n },\n {\n \"name\": \"USN\",\n \"description\": \"United States dollar (next day)\"\n },\n {\n \"name\": \"USS\",\n \"description\": \"United States dollar (same day)\"\n },\n {\n \"name\": \"UYI\",\n \"description\": \"Uruguay Peso en Unidedades Indexadas\"\n },\n {\n \"name\": \"UYU\",\n \"description\": \"Uruguyan peso\"\n },\n {\n \"name\": \"UZS\",\n \"description\": \"Uzbekistan som\"\n },\n {\n \"name\": \"VEF\",\n \"description\": \"Venezuelan bol\\u00edvar soberano\"\n },\n {\n \"name\": \"VND\",\n \"description\": \"Vietnamese \\u0111\\u1ed3ng\"\n },\n {\n \"name\": \"VUV\",\n \"description\": \"Vanuatu vatu\"\n },\n {\n \"name\": \"WST\",\n \"description\": \"Samoan tala\"\n },\n {\n \"name\": \"XAF\",\n \"description\": \"CFA franc BEAC\"\n },\n {\n \"name\": \"XAG\",\n \"description\": \"Silver\"\n },\n {\n \"name\": \"XAU\",\n \"description\": \"Gold\"\n },\n {\n \"name\": \"XBA\",\n \"description\": \"European Composite Unit\"\n },\n {\n \"name\": \"XBB\",\n \"description\": \"European Monetary Unit\"\n },\n {\n \"name\": \"XBC\",\n \"description\": \"European Unit of Account 9\"\n },\n {\n \"name\": \"XBD\",\n \"description\": \"European Unit of Account 17\"\n },\n {\n \"name\": \"XCD\",\n \"description\": \"East Caribbean dollar\"\n },\n {\n \"name\": \"XDR\",\n \"description\": \"Special drawing rights (International Monetary Fund)\"\n },\n {\n \"name\": \"XOF\",\n \"description\": \"CFA franc BCEAO\"\n },\n {\n \"name\": \"XPD\",\n \"description\": \"Palladium\"\n },\n {\n \"name\": \"XPF\",\n \"description\": \"CFP franc\"\n },\n {\n \"name\": \"XPT\",\n \"description\": \"Platinum\"\n },\n {\n \"name\": \"XTS\",\n \"description\": \"Code reserved for testing\"\n },\n {\n \"name\": \"XXX\",\n \"description\": \"No currency\"\n },\n {\n \"name\": \"YER\",\n \"description\": \"Yemeni rial\"\n },\n {\n \"name\": \"ZAR\",\n \"description\": \"South African rand\"\n },\n {\n \"name\": \"ZMK\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"ZMW\",\n \"description\": \"Zambian kwacha\"\n },\n {\n \"name\": \"BTC\",\n \"description\": \"Bitcoin\"\n },\n {\n \"name\": \"XUS\",\n \"description\": \"USD Coin\"\n }\n ],\n \"description\": \"Indicates the associated currency for an amount of money. Values correspond\\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"gan\": {\n \"type\": \"string\",\n \"description\": \"The gift card account number (GAN). Buyers can use the GAN to make purchases or check \\nthe gift card balance.\",\n \"nullable\": true\n },\n \"created_at\": {\n \"type\": \"string\",\n \"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.\",\n \"readOnly\": true\n },\n \"customer_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked.\",\n \"readOnly\": true\n }\n }\n }\n },\n \"example\": {\n \"gift_card\": {\n \"type\": \"DIGITAL\"\n },\n \"idempotency_key\": \"NC9Tm69EjbjtConu\",\n \"location_id\": \"81FN9BNFZTKS4\"\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