{"openapi":"3.1.0","info":{"title":"Forter Tokenization","description":"","version":"v1"},"components":{"securitySchemes":{"http":{"type":"http","scheme":"basic","description":"site_id:site_secret"}},"schemas":{"BasePaymentMethod":{"type":"object","properties":{"cardNumber":{"minLength":10,"maxLength":19,"examples":["4343434343434345"],"type":"string"},"extra":{"maxProperties":10,"type":"object","additionalProperties":{"minLength":0,"maxLength":100,"type":"string"}},"tokenAliases":{"maxProperties":5,"examples":[{"someAlias":"EXTERNAL_TOKEN_7b0d"}],"type":"object","additionalProperties":{"minLength":5,"maxLength":100,"type":"string"}},"customerId":{"anyOf":[{"minLength":2,"maxLength":100,"examples":["123466221"],"description":"An optional id of the customer that owns this payment method. Will allow easier deletion of multiple payment methods later on and help comply with GDPR","type":"string"},{"type":"null"}]}},"required":["cardNumber"]},"NetworkTokenOptions":{"type":"object","properties":{"provision":{"type":"boolean"},"async":{"default":false,"type":"boolean"}},"required":["provision","async"]},"FullPaymentMethodNoCVV":{"allOf":[{"$ref":"#/components/schemas/BasePaymentMethod"},{"type":"object","properties":{"expirationMonth":{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},"expirationYear":{"minimum":2000,"examples":[2030],"type":"integer"},"cardHolderName":{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"}},"required":["expirationMonth","expirationYear","cardHolderName"]}]},"FullPaymentMethodWithCVV":{"allOf":[{"$ref":"#/components/schemas/FullPaymentMethodNoCVV"},{"type":"object","properties":{"cvc":{"anyOf":[{"minLength":3,"maxLength":4,"examples":["123"],"type":"string"},{"type":"null"}]}}}]},"VaultStoreCardPayload":{"allOf":[{"$ref":"#/components/schemas/BasePaymentMethod"},{"type":"object","properties":{"expirationMonth":{"anyOf":[{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},{"type":"null"}]},"expirationYear":{"anyOf":[{"minimum":2000,"examples":[2030],"type":"integer"},{"type":"null"}]},"cardHolderName":{"anyOf":[{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"},{"type":"null"}]},"cvc":{"anyOf":[{"minLength":3,"maxLength":4,"examples":["123"],"type":"string"},{"type":"null"}]}}}]},"TokenizeCVVOnlyPayload":{"additionalProperties":false,"type":"object","properties":{"cvc":{"minLength":3,"maxLength":4,"examples":["123"],"type":"string"},"customerId":{"anyOf":[{"minLength":2,"maxLength":100,"examples":["123466221"],"description":"An optional id of the customer that owns this payment method. Will allow easier deletion of multiple payment methods later on and help comply with GDPR","type":"string"},{"type":"null"}]},"tokenAliases":{"anyOf":[{"maxProperties":5,"examples":[{"someAlias":"EXTERNAL_TOKEN_7b0d"}],"type":"object","additionalProperties":{"minLength":5,"maxLength":100,"type":"string"}},{"type":"null"}]},"siteId":{"anyOf":[{"examples":["someSiteId"],"type":"string"},{"type":"null"}]}},"required":["cvc"]},"TokenizeFullPaymentMethodWithCVVPayload":{"allOf":[{"$ref":"#/components/schemas/FullPaymentMethodWithCVV"},{"type":"object","properties":{"siteId":{"anyOf":[{"examples":["someSiteId"],"type":"string"},{"type":"null"}]}}}]},"TokenizeMultiUsePayloadSchema":{"examples":[{"cardNumber":"4343434343434345","cardHolderName":"Yehonatan Zecharia","expirationYear":2030,"expirationMonth":12,"customerId":"123466221","networkToken":{"provision":false}}],"allOf":[{"$ref":"#/components/schemas/FullPaymentMethodNoCVV"},{"type":"object","properties":{"networkToken":{"$ref":"#/components/schemas/NetworkTokenOptions"}}}]},"TokenizeSingleUsePayload":{"examples":[{"cardNumber":"4343434343434345","cardHolderName":"Yehonatan Zecharia","expirationYear":2030,"expirationMonth":12,"customerId":"123466221","cvc":"123","siteId":"someSiteId"}],"anyOf":[{"$ref":"#/components/schemas/TokenizeFullPaymentMethodWithCVVPayload"},{"$ref":"#/components/schemas/TokenizeCVVOnlyPayload"}]},"HybridEncryptedPayload":{"type":"object","properties":{"kid":{"examples":["prod-v1"],"type":"string"},"alg":{"examples":["RSA-OAEP-256"],"type":"string"},"enc":{"examples":["A256GCM"],"type":"string"},"wrappedKey":{"description":"Base64-encoded RSA-OAEP encrypted AES key","type":"string"},"nonce":{"description":"Base64-encoded 12-byte IV","type":"string"},"ciphertext":{"description":"Base64-encoded encrypted JSON","type":"string"},"tag":{"description":"Base64-encoded 16-byte auth tag","type":"string"},"siteId":{"anyOf":[{"examples":["someSiteId"],"type":"string"},{"type":"null"}]}},"required":["kid","alg","enc","wrappedKey","nonce","ciphertext","tag"]},"DetokenizePayload":{"$ref":"#/components/schemas/FullPaymentMethodWithCVV"},"ProvisionCryptogramResponseSchema":{"type":"object","properties":{"networkToken":{"type":"string"},"cryptogram":{"type":"string"},"eci":{"type":"string"}},"required":["networkToken","cryptogram"]},"VaultRetrieveCardPayload":{"allOf":[{"$ref":"#/components/schemas/BasePaymentMethod"},{"type":"object","properties":{"expirationMonth":{"anyOf":[{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},{"type":"null"}]},"expirationYear":{"anyOf":[{"minimum":2000,"examples":[2030],"type":"integer"},{"type":"null"}]},"cardHolderName":{"anyOf":[{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"},{"type":"null"}]},"cvc":{"anyOf":[{"minLength":3,"maxLength":4,"examples":["123"],"type":"string"},{"type":"null"}]}}}]},"NonPciBasicCardInfo":{"type":"object","properties":{"bin":{"minLength":6,"maxLength":8,"examples":["411111"],"type":"string"},"lastFourDigits":{"minLength":4,"maxLength":4,"examples":["1111"],"type":"string"},"cardBrand":{"examples":["visa"],"type":"string"},"expirationMonth":{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},"expirationYear":{"minimum":2000,"examples":[2030],"type":"integer"},"cardHolderName":{"anyOf":[{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"},{"type":"null"}]}},"required":["bin","lastFourDigits","cardBrand","expirationMonth","expirationYear"]},"CardArtwork":{"type":"object","properties":{"mimeType":{"type":"string"},"encodedData":{"type":"string"}},"required":["mimeType","encodedData"]},"NonPciRichCardInfo":{"allOf":[{"$ref":"#/components/schemas/NonPciBasicCardInfo"},{"type":"object","properties":{"type":{"examples":["credit"],"anyOf":[{"type":"string","enum":["credit"]},{"type":"string","enum":["debit"]},{"type":"string","enum":["prepaid"]}]},"category":{"examples":["consumer"],"anyOf":[{"type":"string","enum":["consumer"]},{"type":"string","enum":["corporate"]},{"type":"string","enum":["government"]},{"type":"string","enum":["commercial"]}]},"country":{"examples":["US"],"description":"2 letter ISO 3166-1 alpha-2 country code","type":"string"},"issuer":{"examples":["Example Bank"],"description":"The issuer of the card","type":"string"},"art":{"$ref":"#/components/schemas/CardArtwork"}}}]},"NetworkTokenStatus":{"type":"object","properties":{"created":{"type":"boolean"},"reason":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["UNKNOWN_ERROR"]},{"type":"string","enum":["ASYNC_PROVISIONING"]},{"type":"string","enum":["DISABLED"]},{"type":"string","enum":["NETWORK_TOKEN_EXISTS"]},{"type":"string","enum":["SCHEME_ERROR"]},{"type":"string","enum":["CARD_NOT_ALLOWED"]},{"type":"string","enum":["INVALID_CARD"]}]},"message":{"type":"string"}},"required":["code","message"]}},"required":["created"]},"TokenPayload":{"type":"object","properties":{"token":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"},"networkTokenStatus":{"$ref":"#/components/schemas/NetworkTokenStatus"},"cardInfo":{"$ref":"#/components/schemas/NonPciBasicCardInfo"}},"required":["token"]},"TokenInfo":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/NonPciRichCardInfo"},"token":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"},"tokenType":{"examples":["multi-use"],"anyOf":[{"type":"string","enum":["single-use"]},{"type":"string","enum":["multi-use"]},{"type":"string","enum":["cvv"]},{"type":"string","enum":["apple-pay-device-data"]},{"type":"string","enum":["apple-pay-cryptogram"]},{"type":"string","enum":["apple-pay-emv"]}]},"networkToken":{"type":"object","properties":{"token":{"examples":["2222850249903093"],"type":"string"},"state":{"examples":["ACTIVE"],"anyOf":[{"type":"string","enum":["ACTIVE"]},{"type":"string","enum":["SUSPENDED"]},{"type":"string","enum":["DELETED"]},{"type":"string","enum":["PENDING"]}]},"expirationMonth":{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},"expirationYear":{"minimum":2000,"examples":[2030],"type":"integer"},"paymentAccountReference":{"anyOf":[{"examples":["5001CKVAXG3BF45LG87F63JVX3AQ0"],"type":"string"},{"type":"null"}]}},"required":["token","state","expirationMonth","expirationYear"]},"tokenFingerprint":{"examples":["dcc68c771b74a22dd7f10f495dba482b5b5489ea8c3aa429106fb7d8fcb288f8"],"type":"string"},"tokenAliases":{"anyOf":[{"maxProperties":5,"examples":[{"someAlias":"EXTERNAL_TOKEN_7b0d"}],"type":"object","additionalProperties":{"minLength":5,"maxLength":100,"type":"string"}},{"type":"null"}]},"customerId":{"anyOf":[{"minLength":2,"maxLength":100,"examples":["123466221"],"description":"An optional id of the customer that owns this payment method. Will allow easier deletion of multiple payment methods later on and help comply with GDPR","type":"string"},{"type":"null"}]}},"required":["card"]},"TokenOrAliasPayload":{"type":"object","properties":{"token":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"},"tokenAlias":{"type":"object","properties":{"key":{"examples":["forter","zooz"],"type":"string"},"value":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"}},"required":["key","value"]}}},"UpgradeTokenPayload":{"allOf":[{"$ref":"#/components/schemas/TokenOrAliasPayload"},{"type":"object","properties":{"networkToken":{"$ref":"#/components/schemas/NetworkTokenOptions"}}}]},"ProvisionNetworkTokenScheme":{"type":"object","properties":{"token":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"},"async":{"default":false,"type":"boolean"}},"required":["token","async"]},"TokenOrAliasQuerystring":{"type":"object","properties":{"token":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"},"tokenAliasKey":{"examples":["forter","zooz"],"type":"string"},"tokenAliasValue":{"examples":["ftr1d8a56cfa6b3745a39e4a42d5ab1048c8"],"type":"string"}}},"AuthorizationHeader":{"type":"object","properties":{"authorization":{"examples":["Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6InRlc3QiLCJpYXQiOjE1MTYyMzkwMjJ9.5TNt1_8bcHhyE4b6cc53M5tD6DgogzQWKVI94cddhT0"],"type":"string"}}},"CreateClientKeyPayload":{"type":"object","properties":{"ttlMinutes":{"minimum":1,"maximum":1440,"default":30,"examples":[60],"type":"integer"}},"required":["ttlMinutes"]},"CreateClientKeyResponse":{"type":"object","properties":{"clientKey":{"examples":["eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6InRlc3QiLCJpYXQiOjE1MTYyMzkwMjJ9.5TNt1_8bcHhyE4b6cc53M5tD6DgogzQWKVI94cddhT0"],"type":"string"}},"required":["clientKey"]},"TokenizationErrorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"RequestContextInternalResponse":{"type":"object","properties":{"activeFeatureFlags":{"type":"array","items":{"type":"string"}}},"required":["activeFeatureFlags"]},"CreateSitePayload":{"type":"object","properties":{"siteId":{"type":"string"},"siteNumber":{"type":"number"}},"required":["siteId","siteNumber"]},"CreateSiteSecretPayload":{"type":"object","properties":{"siteId":{"type":"string"},"secretType":{"type":"string"},"secret":{"type":"string"}},"required":["siteId","secretType"]},"CreateScopedApiKeyPayload":{"type":"object","properties":{"siteId":{"type":"string"},"label":{"minLength":1,"maxLength":100,"type":"string"},"scope":{"anyOf":[{"type":"string","enum":["FULL_ACCESS"]},{"type":"string","enum":["TOKENIZE_ONLY"]}]}},"required":["siteId","label","scope"]},"RotateScopedApiKeyPayload":{"type":"object","properties":{"siteId":{"type":"string"},"label":{"type":"string"}},"required":["siteId","label"]},"RevokeScopedApiKeyPayload":{"type":"object","properties":{"siteId":{"type":"string"},"label":{"type":"string"}},"required":["siteId","label"]},"ListScopedApiKeysQuery":{"type":"object","properties":{"siteId":{"type":"string"}},"required":["siteId"]},"CreateApplePayKeysPayload":{"type":"object","properties":{"siteId":{"type":"string"}},"required":["siteId"]},"RotateApplePayKeysPayload":{"type":"object","properties":{"siteId":{"type":"string"}},"required":["siteId"]},"CreateApplePayKeysResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"RotateApplePayKeysResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"CreateApplePayCSRPayload":{"type":"object","properties":{"siteId":{"type":"string"},"organizationName":{"examples":["Forter"],"type":"string"},"countryName":{"examples":["US"],"type":"string"},"rotateKeys":{"type":"boolean"}},"required":["siteId"]},"UploadApplePayCertificatePayload":{"type":"object","properties":{"siteId":{"type":"string"},"certificate":{"examples":["-----BEGIN CERTIFICATE-----..."],"type":"string"}},"required":["siteId","certificate"]},"CreateApplePayCSRResponse":{"type":"object","properties":{"csr":{"examples":["-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----"],"type":"string"}},"required":["csr"]},"UploadApplePayCertificateResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"AddCollectionPropertyPayload":{"type":"object","properties":{"collection":{"type":"string"},"vault":{"anyOf":[{"type":"string","enum":["main"]},{"type":"string","enum":["dr"]}]},"property":{"type":"object","properties":{"name":{"type":"string"},"data_type_name":{"type":"string"},"is_nullable":{"type":"boolean"},"is_encrypted":{"type":"boolean"},"is_index":{"type":"boolean"}},"required":["name","data_type_name"]}},"required":["collection","vault","property"]},"AddCollectionPropertyResponse":{"type":"object","properties":{"vault":{"anyOf":[{"type":"string","enum":["main"]},{"type":"string","enum":["dr"]}]},"collection":{"type":"string"},"property":{"type":"string"}},"required":["vault","collection","property"]},"AddCollectionPropertyErrorResponse":{"type":"object","properties":{"vault":{"anyOf":[{"type":"string","enum":["main"]},{"type":"string","enum":["dr"]}]},"collection":{"type":"string"},"property":{"type":"string"},"error":{}},"required":["vault","collection","property","error"]},"PciProxyNetworkTokenUpdate":{"type":"object","properties":{"alias":{"type":"string"},"fingerprint":{"type":"string"},"type":{"type":"string"},"card":{"type":"object","properties":{"panRemoved":{"type":"boolean"},"bin":{"type":"string"},"last4":{"type":"string"},"expiryMonth":{"type":"string"},"expiryYear":{"type":"string"},"networkToken":{"type":"object","properties":{"expiryMonth":{"type":"string"},"expiryYear":{"type":"string"},"status":{"type":"string"},"paymentAccountReference":{"type":"string"}},"required":["expiryMonth","expiryYear","status","paymentAccountReference"]}},"required":["panRemoved","bin","last4","expiryMonth","expiryYear","networkToken"]}},"required":["alias","fingerprint","type","card"]},"PciProxyHeaders":{"type":"object","properties":{"request-signature":{"examples":["t=1605697463,s0=82ef9a8178dcb4df0b71540fa06d7da826ecb26e1977e230bdc8c9d6f9f1af84"],"type":"string"}}},"VgsHeaders":{"type":"object","properties":{"vgs-signature":{"examples":["t=1623691785,v0=9370aa8513da0a14d21478f11f039708f7e664bfffebb939f574e57818ce08de"],"type":"string"}}},"SiteIdParam":{"type":"object","properties":{"siteId":{"examples":["954fce831acf"],"type":"string"}},"required":["siteId"]},"ApplePayLifecycleNotificationParams":{"type":"object","properties":{"siteId":{"examples":["954fce831acf"],"type":"string"},"eventId":{"examples":["evt_123abc"],"type":"string"}},"required":["siteId","eventId"]},"CardData":{"examples":[{"cardNumber":"4444555566660006","expirationMonth":12,"expirationYear":2025}],"type":"object","properties":{"cardNumber":{"minLength":10,"maxLength":19,"examples":["4343434343434345"],"type":"string"},"expirationMonth":{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},"expirationYear":{"minimum":2000,"maximum":2126,"examples":["2025"],"type":"integer"},"cardHolderName":{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"}},"required":["cardNumber","expirationMonth","expirationYear"]},"CardDataResponse":{"examples":[{"status":"CARD_NUMBER_UPDATED","card":{"cardNumber":"4444555566660006","expirationMonth":12,"expirationYear":2025}}],"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["CARD_NUMBER_UPDATED"]},{"type":"string","enum":["CARD_EXPIRATION_UPDATED"]},{"type":"string","enum":["CARD_NOT_UPDATED_DUE_TO_FAILURE"]},{"type":"string","enum":["CARD_CLOSED"]},{"type":"string","enum":["CARD_NOT_FOUND"]},{"type":"string","enum":["CONTACT_CARDHOLDER"]},{"type":"string","enum":["CARDHOLDER_OPT_OUT"]},{"type":"string","enum":["NON_PARTICIPATING_ACCOUNT"]},{"type":"string","enum":["REJECTED"]},{"type":"string","enum":["NO_UPDATES_AVAILABLE"]},{"type":"string","enum":["ENROLLED"]}]},"card":{"type":"object","properties":{"cardNumber":{"minLength":10,"maxLength":19,"examples":["4343434343434345"],"type":"string"},"expirationMonth":{"minimum":1,"maximum":12,"examples":[12],"type":"integer"},"expirationYear":{"minimum":2000,"maximum":2126,"examples":["2025"],"type":"integer"},"cardHolderName":{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"}},"required":["cardNumber","expirationMonth","expirationYear"]}},"required":["status","card"]},"AccountUpdaterError":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"EnrollResponse":{"type":"object","properties":{}},"TokenUpdateRequest":{"$ref":"#/components/schemas/TokenOrAliasPayload"},"TokenUpdateResponse":{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["CARD_NUMBER_UPDATED"]},{"type":"string","enum":["CARD_EXPIRATION_UPDATED"]},{"type":"string","enum":["CARD_NOT_UPDATED_DUE_TO_FAILURE"]},{"type":"string","enum":["CARD_CLOSED"]},{"type":"string","enum":["CARD_NOT_FOUND"]},{"type":"string","enum":["CONTACT_CARDHOLDER"]},{"type":"string","enum":["CARDHOLDER_OPT_OUT"]},{"type":"string","enum":["NON_PARTICIPATING_ACCOUNT"]},{"type":"string","enum":["REJECTED"]},{"type":"string","enum":["NO_UPDATES_AVAILABLE"]},{"type":"string","enum":["ENROLLED"]}]},"card":{"type":"object","properties":{"lastFour":{"type":"string"},"expirationMonth":{"type":"number"},"expirationYear":{"type":"number"},"cardHolderName":{"minLength":1,"maxLength":100,"examples":["Yehonatan Zecharia"],"type":"string"}},"required":["lastFour","expirationMonth","expirationYear"]}},"required":["status","card"]},"UpdateError":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ApplePayTokenPayload":{"type":"object","properties":{"payload":{"type":"object","properties":{"token":{"type":"object","properties":{"paymentData":{"type":"object","properties":{"data":{"type":"string"},"signature":{"type":"string"},"version":{"type":"string"},"header":{"type":"object","properties":{"ephemeralPublicKey":{"type":"string"},"publicKeyHash":{"type":"string"},"transactionId":{"type":"string"}},"required":["ephemeralPublicKey","publicKeyHash","transactionId"]}},"required":["data","signature","version","header"]}},"required":["paymentData"]}},"required":["token"]},"customerId":{"anyOf":[{"minLength":2,"maxLength":100,"examples":["123466221"],"description":"An optional id of the customer that owns this payment method. Will allow easier deletion of multiple payment methods later on and help comply with GDPR","type":"string"},{"type":"null"}]},"tokenAliases":{"anyOf":[{"maxProperties":5,"type":"object","additionalProperties":{"minLength":5,"maxLength":100,"type":"string"}},{"type":"null"}]}},"required":["payload"]},"TokenizeApplePayResponse":{"type":"object","properties":{"applePayDeviceDataToken":{"type":"string"},"paymentCredentialsToken":{"type":"string"}},"required":["applePayDeviceDataToken","paymentCredentialsToken"]},"WalletErrorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}},"paths":{"/v1/tokenization/tokenize":{"post":{"operationId":"tokenize","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeMultiUsePayloadSchema"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayload"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/tokenize-single-use":{"post":{"operationId":"tokenize-single-use","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeSingleUsePayload"}}}},"parameters":[{"schema":{"type":"string"},"example":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6InRlc3QiLCJpYXQiOjE1MTYyMzkwMjJ9.5TNt1_8bcHhyE4b6cc53M5tD6DgogzQWKVI94cddhT0","in":"header","name":"authorization","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayload"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/tokenize-encrypted":{"post":{"operationId":"tokenize-encrypted","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HybridEncryptedPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayload"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/detokenize":{"post":{"operationId":"detokenize","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOrAliasPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetokenizePayload"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/provision-cryptogram":{"post":{"operationId":"provision-cryptogram","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOrAliasPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionCryptogramResponseSchema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/provision-network-token":{"post":{"operationId":"provision-network-token","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionNetworkTokenScheme"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkTokenStatus"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/upgrade":{"post":{"operationId":"upgrade","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeTokenPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenPayload"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/delete":{"post":{"operationId":"delete","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOrAliasPayload"}}}},"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/token-info":{"get":{"operationId":"token-info","tags":["v1/tokenization"],"parameters":[{"schema":{"type":"string"},"example":"ftr1d8a56cfa6b3745a39e4a42d5ab1048c8","in":"query","name":"token","required":false},{"schema":{"type":"string"},"examples":{"forter":{"value":"forter"},"zooz":{"value":"zooz"}},"in":"query","name":"tokenAliasKey","required":false},{"schema":{"type":"string"},"example":"ftr1d8a56cfa6b3745a39e4a42d5ab1048c8","in":"query","name":"tokenAliasValue","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInfo"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/tokenization/client-key":{"post":{"operationId":"client-key","tags":["v1/tokenization"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientKeyPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientKeyResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizationErrorResponse"}}}}}}},"/v1/account-updater/card/update":{"post":{"operationId":"card-update","tags":["v1/account-updater"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardData"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardDataResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdaterError"}}}}}}},"/v1/account-updater/token/enroll":{"post":{"operationId":"token-enroll","tags":["v1/account-updater"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOrAliasPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdaterError"}}}}}}},"/v1/account-updater/token/update":{"post":{"operationId":"token-update","tags":["v1/account-updater"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUpdateRequest"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenUpdateResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateError"}}}}}}},"/v1/agentic/ucp/tokenize":{"post":{"operationId":"ucp-tokenize","tags":["v1/agentic"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["card"]},"card_number_type":{"type":"string","enum":["fpan"]},"number":{"minLength":13,"maxLength":19,"type":"string"},"expiry_month":{"minimum":1,"maximum":12,"type":"number"},"expiry_year":{"minimum":2010,"type":"number"},"cvc":{"minLength":3,"maxLength":4,"type":"string"},"name":{"type":"string"}},"required":["type","card_number_type","number","expiry_month","expiry_year"]},{"type":"object","properties":{"type":{"type":"string","enum":["card"]},"card_number_type":{"type":"string","enum":["network_token"]},"number":{"minLength":13,"maxLength":19,"type":"string"},"expiry_month":{"minimum":1,"maximum":12,"type":"number"},"expiry_year":{"minimum":2010,"type":"number"},"cryptogram":{"type":"string"},"eci_value":{"type":"string"},"name":{"type":"string"}},"required":["type","card_number_type","number","expiry_month","expiry_year","cryptogram"]}]},"binding":{"type":"object","properties":{"checkout_id":{"type":"string"},"identity":{"type":"object","properties":{"site_id":{"type":"string"},"access_token":{"type":"string"}},"required":["site_id","access_token"]}},"required":["checkout_id","identity"]}},"required":["credential","binding"]}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"]}}}}}}},"/v1/agentic/ucp/tokenizer_spec":{"get":{"operationId":"ucp-tokenizer_spec","tags":["v1/agentic"],"responses":{"200":{"description":"Default Response"}}}},"/v1/agentic/ucp/tokenize_schema.json":{"get":{"operationId":"ucp-tokenize_schema.json","tags":["v1/agentic"],"responses":{"200":{"description":"Default Response"}}}},"/v1/agentic/acp/agentic_commerce/delegate_payment":{"post":{"operationId":"acp-agentic_commerce-delegate_payment","tags":["v1/agentic"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payment_method":{"type":"object","properties":{"type":{"type":"string","enum":["card"]},"card_number_type":{"anyOf":[{"type":"string","enum":["fpan"]},{"type":"string","enum":["network_token"]}]},"number":{"minLength":13,"maxLength":19,"type":"string"},"exp_month":{"maxLength":2,"type":"string"},"exp_year":{"maxLength":4,"type":"string"},"name":{"type":"string"},"cvc":{"maxLength":4,"type":"string"},"checks_performed":{"type":"array","items":{"anyOf":[{"type":"string","enum":["avs"]},{"type":"string","enum":["cvv"]},{"type":"string","enum":["ani"]},{"type":"string","enum":["auth0"]}]}},"iin":{"maxLength":6,"type":"string"},"display_card_funding_type":{"anyOf":[{"type":"string","enum":["credit"]},{"type":"string","enum":["debit"]},{"type":"string","enum":["prepaid"]}]},"display_brand":{"type":"string"},"display_last4":{"minLength":4,"maxLength":4,"pattern":"^\\d{4}$","type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["type","card_number_type","number","display_card_funding_type"]},"allowance":{"type":"object","properties":{"reason":{"type":"string","enum":["one_time"]},"max_amount":{"type":"number"},"currency":{"minLength":3,"maxLength":3,"pattern":"^[a-z]{3}$","type":"string"},"checkout_session_id":{"type":"string"},"merchant_id":{"maxLength":256,"type":"string"},"expires_at":{"type":"string"}},"required":["reason","max_amount","currency","checkout_session_id","merchant_id","expires_at"]},"risk_signals":{"minItems":1,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["card_testing"]},"score":{"type":"number"},"action":{"anyOf":[{"type":"string","enum":["blocked"]},{"type":"string","enum":["manual_review"]},{"type":"string","enum":["authorized"]}]}},"required":["type","score","action"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"billing_address":{"type":"object","properties":{"name":{"maxLength":256,"type":"string"},"line_one":{"maxLength":256,"type":"string"},"line_two":{"maxLength":256,"type":"string"},"city":{"maxLength":60,"type":"string"},"state":{"maxLength":60,"type":"string"},"country":{"minLength":2,"maxLength":2,"type":"string"},"postal_code":{"maxLength":20,"type":"string"}}}},"required":["payment_method","allowance","risk_signals"]}}},"required":true},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["id","created","metadata"]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message"]}}}}}}},"/v1/wallet/tokenize-apple-pay":{"post":{"operationId":"tokenize-apple-pay","tags":["v1/wallet"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePayTokenPayload"}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenizeApplePayResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletErrorResponse"}}}}}}}},"servers":[{"url":"https://pci-tokenization-sandbox.checkouttools.com"}],"security":[{"http":[]}]}