Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jan 8, 2024
1 parent df79eaa commit c0321fe
Show file tree
Hide file tree
Showing 34 changed files with 9,051 additions and 765 deletions.
269 changes: 243 additions & 26 deletions json/CheckoutService-v37.json
Original file line number Diff line number Diff line change
Expand Up @@ -933,34 +933,19 @@
}
],
"responses" : {
"200" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-paymentLinks-basic-200"
"$ref" : "#/components/examples/post-paymentLinks-basic-201"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResponse"
}
}
},
"description" : "Created - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
Expand Down Expand Up @@ -4106,6 +4091,41 @@
"title" : "Apple Pay",
"type" : "object"
},
"ApplePayDonations" : {
"additionalProperties" : false,
"properties" : {
"applePayToken" : {
"description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.",
"maxLength" : 10000,
"type" : "string"
},
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"credit",
"debit"
],
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "applepay",
"description" : "**applepay**",
"enum" : [
"applepay"
],
"type" : "string"
}
},
"required" : [
"applePayToken"
],
"title" : "Apple Pay",
"type" : "object"
},
"ApplePaySessionRequest" : {
"properties" : {
"displayName" : {
Expand Down Expand Up @@ -4589,9 +4609,7 @@
"description" : "**billdesk**",
"enum" : [
"billdesk_online",
"billdesk_wallet",
"onlinebanking_IN",
"wallet_IN"
"billdesk_wallet"
],
"type" : "string"
}
Expand Down Expand Up @@ -4864,8 +4882,10 @@
"default" : "scheme",
"description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.",
"enum" : [
"bcmc",
"scheme",
"networkToken",
"giftcard",
"card"
],
"type" : "string"
Expand Down Expand Up @@ -4918,6 +4938,98 @@
},
"type" : "object"
},
"CardDonations" : {
"additionalProperties" : false,
"properties" : {
"brand" : {
"description" : "Secondary brand of the card. For example: **plastix**, **hmclub**.",
"type" : "string"
},
"cupsecureplus.smscode" : {
"deprecated" : true,
"type" : "string"
},
"cvc" : {
"description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"encryptedCardNumber" : {
"description" : "The encrypted card number.",
"maxLength" : 15000,
"type" : "string"
},
"encryptedExpiryMonth" : {
"description" : "The encrypted card expiry month.",
"maxLength" : 15000,
"type" : "string"
},
"encryptedExpiryYear" : {
"description" : "The encrypted card expiry year.",
"maxLength" : 15000,
"type" : "string"
},
"encryptedSecurityCode" : {
"description" : "The encrypted card verification code.",
"maxLength" : 15000,
"type" : "string"
},
"expiryMonth" : {
"description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"expiryYear" : {
"description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"credit",
"debit"
],
"type" : "string"
},
"holderName" : {
"description" : "The name of the card holder.",
"type" : "string"
},
"networkPaymentReference" : {
"description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
"type" : "string"
},
"number" : {
"description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"shopperNotificationReference" : {
"description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.",
"type" : "string"
},
"threeDS2SdkVersion" : {
"description" : "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.",
"maxLength" : 12,
"type" : "string"
},
"type" : {
"default" : "scheme",
"description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.",
"enum" : [
"bcmc",
"scheme",
"networkToken",
"giftcard",
"card"
],
"type" : "string"
}
},
"title" : "Card",
"type" : "object"
},
"CellulantDetails" : {
"additionalProperties" : false,
"properties" : {
Expand Down Expand Up @@ -5467,19 +5579,19 @@
"description" : "The type and required details of a payment method to use.",
"oneOf" : [
{
"$ref" : "#/components/schemas/ApplePayDetails"
"$ref" : "#/components/schemas/ApplePayDonations"
},
{
"$ref" : "#/components/schemas/CardDetails"
"$ref" : "#/components/schemas/CardDonations"
},
{
"$ref" : "#/components/schemas/GooglePayDetails"
"$ref" : "#/components/schemas/GooglePayDonations"
},
{
"$ref" : "#/components/schemas/IdealDetails"
"$ref" : "#/components/schemas/IdealDonations"
},
{
"$ref" : "#/components/schemas/PayWithGoogleDetails"
"$ref" : "#/components/schemas/PayWithGoogleDonations"
}
]
},
Expand Down Expand Up @@ -5882,9 +5994,20 @@
"description" : "The address where to send the invoice.",
"$ref" : "#/components/schemas/Address"
},
"shopperEmail" : {
"description" : "Email address of the person.",
"type" : "string"
},
"shopperName" : {
"description" : "The name of the person",
"$ref" : "#/components/schemas/Name"
},
"telephoneNumber" : {
"description" : "Phone number of the person",
"type" : "string"
},
"walletIdentifier" : {
"type" : "string"
}
},
"type" : "object"
Expand Down Expand Up @@ -6019,6 +6142,40 @@
"title" : "Google Pay",
"type" : "object"
},
"GooglePayDonations" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"credit",
"debit"
],
"type" : "string"
},
"googlePayToken" : {
"description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "googlepay",
"description" : "**googlepay**, **paywithgoogle**",
"enum" : [
"googlepay"
],
"type" : "string"
}
},
"required" : [
"googlePayToken"
],
"title" : "Google Pay",
"type" : "object"
},
"IdealDetails" : {
"additionalProperties" : false,
"properties" : {
Expand All @@ -6045,6 +6202,32 @@
"title" : "iDEAL",
"type" : "object"
},
"IdealDonations" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "ideal",
"description" : "**ideal**",
"enum" : [
"ideal"
],
"type" : "string"
}
},
"required" : [
"issuer"
],
"title" : "iDEAL",
"type" : "object"
},
"InputDetail" : {
"properties" : {
"configuration" : {
Expand Down Expand Up @@ -6575,6 +6758,40 @@
"title" : "Google Pay",
"type" : "object"
},
"PayWithGoogleDonations" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"credit",
"debit"
],
"type" : "string"
},
"googlePayToken" : {
"description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "paywithgoogle",
"description" : "**paywithgoogle**",
"enum" : [
"paywithgoogle"
],
"type" : "string"
}
},
"required" : [
"googlePayToken"
],
"title" : "Google Pay",
"type" : "object"
},
"PaymentAmountUpdateRequest" : {
"properties" : {
"amount" : {
Expand Down Expand Up @@ -10455,7 +10672,7 @@
}
}
},
"post-paymentLinks-basic-200" : {
"post-paymentLinks-basic-201" : {
"summary" : "Payment link created",
"value" : {
"amount" : {
Expand Down
Loading

0 comments on commit c0321fe

Please sign in to comment.