diff --git a/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md b/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md index aaa913298..bd6fe55f8 100644 --- a/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md +++ b/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md @@ -7,7 +7,7 @@ description: This mutation creates a new cart in Payment Services, supporting gu -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `addProductsToNewCart` mutation always creates a new cart for the shopper then adds the specified products to that cart. This contrasts with the `addProductsToCart` mutation, which requires you to specify an existing cart ID as input. diff --git a/src/pages/graphql/payment-services-extension/mutations/complete-order.md b/src/pages/graphql/payment-services-extension/mutations/complete-order.md index b49066bbe..3d50741f2 100644 --- a/src/pages/graphql/payment-services-extension/mutations/complete-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/complete-order.md @@ -7,7 +7,7 @@ description: This mutation synchronizes order details before you run the `placeO -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `completeOrder` mutation synchronizes order details before you run the `placeOrder` mutation. @@ -42,6 +42,10 @@ mutation { } ``` +## Reference + +The [`completeOrder`](/reference/graphql/saas/index.md#completeorder) reference provides detailed information about the types and fields defined in this mutation. + ## Example usage **Request:** @@ -79,45 +83,3 @@ mutation { } } ``` - -## Input attributes - -### CompleteOrderInput - -| Field | Type | Description | -|-------|------|--------------| -| `cartId` | String! | The unique identifier of the shopping cart (quote). | -| `id` | String! | The payment, checkout, or transaction identifier tied to the order. | - -## Output attributes - -### CompleteOrderOutput - -| Field | Type | Description | -|-------|------|--------------| -| `errors` | Error! | List of error objects. The array is empty if there are no errors. | -| `orderV2` | OrderV2 | Contains minimal order details if successful. | - -### OrderV2 object - -| Field | Type | Description | -|-------|------|--------------| -| `number` | String | The order number assigned by the system. | -| `token` | String | A token that can be used to retrieve the order, especially for guest checkouts. | - -### Error object - -| Field | Type | Description | -|-------|------|--------------| -| `code` | String | A machine-readable error code. | -| `message` | String | A human-readable message describing the error. | - -#### Possible error codes - -| Code | Description | -|------|--------------| -| `CART_NOT_FOUND` | The provided cart ID does not exist. | -| `CART_NOT_ACTIVE` | The cart is not active (already converted or expired). | -| `GUEST_EMAIL_MISSING` | A guest cart does not have an email address assigned. | -| `PAYMENT_ID_INVALID` | The provided payment or transaction ID is invalid. | -| `UNABLE_TO_COMPLETE_ORDER` | A general error occurred while finalizing the order (for example, missing information or out-of-stock items). | diff --git a/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md b/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md index 681d8dc55..19f8a0644 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md @@ -7,7 +7,7 @@ description: This mutation creates a payment order for later processing when Pay -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.3.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `createPaymentOrder` mutation creates a payment order for later processing with Payment Services enabled. @@ -20,6 +20,8 @@ The mutation can return details about the following payment methods supported in Each of these payment methods can have a different payment source, for example, PayPal Hosted Fields only works with credit cards. You need to run `getPaymentConfig` and `setPaymentMethodOnCart` endpoints before running the `createPaymentOrder` mutation. +See [PayPal currency codes](https://developer.paypal.com/reference/currency-codes/) documentation for more information about the value of the `currency_code` in the response. + ## Syntax ```graphql @@ -32,7 +34,7 @@ mutation { ## Reference -The [`createPaymentOrder`](/reference/graphql/index.md#createpaymentorder) reference provides detailed information about the types and fields defined in this mutation. +The [`createPaymentOrder`](/reference/graphql/saas/index.md#createpaymentorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage @@ -73,29 +75,3 @@ mutation { } } ``` - -## Input attributes - -The `CreatePaymentOrderInput` object contains the following input attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `cartId` | String! | The unique ID of the cart | -| `location` | PaymentLocation! | The origin location for that payment request. The possible values are `PRODUCT_DETAIL`, `MINICART`, `CART`, `CHECKOUT`, `ADMIN` | -| `methodCode` | String! | The code for the selected payment method | -| `paymentSource` | String! | The payment source for the payment method The possible values are credit card (`cc`), PayPal (`paypal`), and Apple Pay (`applepay`) | -| `vaultIntent` | Boolean | Indicates whether the payment information should be vaulted. This attribute is only applicable to the `hosted_fields` payment method. The default value is `false` | - -## Output attributes - -The `CreatePaymentOrderOutput` object contains the payment order details that are needed to fulfill a payment. - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `id` | String | The unique order ID generated by PayPal | -| `mp_order_id` | String | The unique order ID generated in Commerce if Payment Services is enabled after PayPal returns the `id` | -| `status` | String | The status of the payment order. See [order status](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/order-management/orders/order-status) for more information | -| `amount` | Float | The amount of the payment order | -| `currency_code` | String | The currency code of the payment order | - -See [PayPal currency codes](https://developer.paypal.com/reference/currency-codes/) documentation for more information. diff --git a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md index d5f2cf995..23ca04ed8 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md @@ -7,7 +7,7 @@ description: This mutation stores a permanent payment token for later purchases. -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `createVaultCardPaymentToken` mutation creates a permanent `vault_token_id` and associates an optional card description, visible in the storefront. @@ -25,7 +25,7 @@ mutation { ## Reference -The [`createVaultCardPaymentToken`](/reference/graphql/index.md#createvaultcardpaymenttoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createVaultCardPaymentToken`](/reference/graphql/saas/index.md#createvaultcardpaymenttoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage @@ -71,39 +71,3 @@ mutation { } } ``` - -## Input attributes - -The `CreateVaultCardPaymentTokenInput` object contains the following input attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `setup_token_id` | String! | The `setup_token` obtained with the `createVaultCardSetupToken` mutation | -| `card_description` | String | The description of the vaulted card | - -## Output attributes - -The `CreateVaultCardPaymentTokenOutput` object contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `vault_token_id` | String! | The vault payment token information | -| `payment_source` | PaymentSourceOutput! | The payment source information | - -### `PaymentSourceOutput` attributes - -The `PaymentSourceOutput` object describes the payment source information. It contains the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `card` | CardPaymentSourceOutput! | The card payment source information. | - -### `CardPaymentSourceOutput` object - -The `CardPaymentSourceOutput` object describes the card payment source information - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `brand` | String | The brand of the card | -| `last_digits` | String | Last digits of the card | -| `expiry` | String | The expiry date of the card | diff --git a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md index 7de58bcb5..ed06cf68d 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md @@ -7,7 +7,7 @@ description: This mutation creates a temporary token associated to the given pay -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `createVaultCardSetupToken` mutation creates a temporary `setup_token` associated to the given payment source. @@ -29,7 +29,7 @@ mutation { ## Reference -The [`createVaultCardSetupToken`](/reference/graphql/index.md#createvaultcardsetuptoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createVaultCardSetupToken`](/reference/graphql/saas/index.md#createvaultcardsetuptoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage @@ -75,66 +75,3 @@ mutation { } } ``` - -## Input attributes - -The `CreateVaultCardSetupTokenInput` object must contain the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `setup_token` | VaultSetupTokenInput! | The setup token information | -| `three_ds_mode` | ThreeDSMode | Indicates which 3D Secure authentication mode is in use. The possible values are `OFF`, `SCA_ALWAYS`, `SCA_WHEN_REQUIRED` | - -### `ThreeDSMode` enum values - -| Value | Description | -| --- | --- | -| `OFF` | No 3D Secure authentication mode is in use | -| `SCA_ALWAYS` | Triggers 3D Secure authentication for every transaction, regardless of any SCA requirements | -| `SCA_WHEN_REQUIRED` | Returns a 3D Secure authentication when it is a mandate in the region where you operate. This is the default value | - -### `VaultSetupTokenInput` attribute - -The `VaultSetupTokenInput` object describes the variables needed to create a vault card setup token. Requires the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `payment_source` | PaymentSourceInput! | The payment source of the payment method. | - -### `PaymentSourceInput` attribute - -The `PaymentSourceInput` object describes the payment source information of the payment method. - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `card` | CardPaymentSourceInput! | The card payment source information. | - -### `CardPaymentSourceInput` object - -The `CardPaymentSourceInput` object describes the card payment source information. - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `billing_address` | BillingAddressPaymentSourceInput! | The billing address of the card | -| `name` | String! | The cardholder's name | - -### `BillingAddressPaymentSourceInput` object - -The `BillingAddressPaymentSourceInput` object includes the billing address information - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `address_line_1` | String | The first line of the address | -| `address_line_2` | String | The second line of the address | -| `region` | String | The region of the address | -| `city` | String | The city of the address | -| `postal_code` | String | The postal code of the address | -| `country_code` | String! | The country code of the address | - -## Output attributes - -The `createVaultCardSetupTokenOutput` object contains the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `setup_token` | String! | The setup token ID | diff --git a/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md b/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md index 7c59f5ed5..da898177c 100644 --- a/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md +++ b/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md @@ -7,7 +7,7 @@ description: This mutation marks a cart as inactive in Payment Services, helping -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `setCartAsInactive` mutation sets a specific `cartId` as inactive. Use this mutation when a payment error occurs, or when a shopper cancels a payment flow, after the [`addProductsToNewCart`](add-products-new-cart.md) mutation returns a `cartId`. This mutation helps prevent a customer having multiple active carts created with the [`addProductsToNewCart`](add-products-new-cart.md) mutation. diff --git a/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md b/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md index 9c90402ec..e2ca83b38 100644 --- a/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md @@ -7,7 +7,7 @@ description: This mutation synchronizes the payment order details for the PayPal -This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.3.0 or higher. +This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this mutation. The `syncPaymentOrder` mutation synchronizes the payment order details for the PayPal Smart Buttons and Apple Pay payment methods. This mutation updates the quote with the shipping, billing, email, and phone number details. It returns a Boolean value indicating whether the synchronization was successful. @@ -25,7 +25,7 @@ mutation { ## Reference -The [`syncPaymentOrder`](/reference/graphql/index.md#syncpaymentorder) reference provides detailed information about the types and fields defined in this mutation. +The [`syncPaymentOrder`](/reference/graphql/saas/index.md#syncpaymentorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage @@ -51,12 +51,3 @@ mutation { } } ``` - -## Input attributes - -The `SyncPaymentOrderInput` object must contain the following input attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `cartId` | String! | The unique ID of the cart | -| `id` | String! | The unique order ID generated by PayPal | diff --git a/src/pages/graphql/payment-services-extension/queries/get-payment-config.md b/src/pages/graphql/payment-services-extension/queries/get-payment-config.md index 45d6b7ca1..621e4b5c9 100644 --- a/src/pages/graphql/payment-services-extension/queries/get-payment-config.md +++ b/src/pages/graphql/payment-services-extension/queries/get-payment-config.md @@ -7,7 +7,7 @@ description: This query returns the payment configuration details from locations -This query is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.3.0 or higher. +This query is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this query. The `getPaymentConfig` query returns the payment configuration details from locations in the storefront and Admin where the payment method can be set. @@ -32,7 +32,7 @@ Each of these payment methods can have a different payment source, for example, ## Reference -The [`getPaymentConfig`](/reference/graphql/index.md#getpaymentconfig) reference provides detailed information about the types and fields defined in this query. +The [`getPaymentConfig`](/reference/graphql/saas/index.md#getpaymentconfig) reference provides detailed information about the types and fields defined in this query. ## Example usage @@ -253,148 +253,10 @@ The following example runs the `getPaymentConfig` query for a `location: CHECKOU } ``` -## Input attributes +## Related information -The `getPaymentConfig` query requires the following input attribute: +[Payment options](https://experienceleague.adobe.com/en/docs/commerce/payment-services/payments-checkout/payments-options) -| Attribute | Data Type | Description | -| --- | --- | --- | -| `location` | PaymentLocation! | The origin location for that payment request. The possible values are `PRODUCT_DETAIL`, `MINICART`, `CART`, `CHECKOUT`, `ADMIN` | +[Google Pay API request object options](https://developers.google.com/pay/api/web/reference/request-objects) -## Output attributes - -The `PaymentConfigOutput` contains details about each configured payment method: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `ApplePayConfig` | String! | Apple Pay payment method configuration | -| `GooglePayConfig` | String! | Google Pay payment method configuration | -| `HostedFieldsConfig` | String! | PayPal Hosted fields payment method configuration | -| `SmartButtonsConfig` | String! | PayPal Smart Buttons payment method configuration | - -Each of these output attributes implements the `PaymentConfigItem` interface. - -## `PaymentConfigItem` interface - -The `PaymentConfigItem` interface contains the fields that are common to all the payment methods. This interface contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `code` | String | The payment method code as defined in the payment gateway | -| `is_visible` | Boolean | Indicates whether the payment method is shown | -| `payment_intent` | String | Defines the payment intent. The possible values are `Authorize` or `Capture` | -| `sdk_params` | SDKParams | PayPal parameters required to load the PayPal JavaScript SDK | -| `sort_order` | String | The relative order the payment method is displayed on the checkout page | -| `title` | String! | The display name of the payment method | - -This interface also has the following implementations: - -* ApplePayConfig -* GooglePayConfig -* HostedFieldsConfig -* SmartButtonsConfig - -Each implementation contains objects with specific attributes for each of these payment methods. - -### `ApplePayConfig` attributes - -The `ApplePayConfig` payment method configuration has a `button_styles` object containing the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `color` | String | The button color | -| `height` | Int | The button height in pixels | -| `label` | String | The button label | -| `layout` | String | The button layout | -| `shape` | String | The button shape | -| `tagline` | Boolean | Indicates whether the tagline is displayed | -| `use_default_height` | Boolean | Defines if button uses default height. If the value is `False`, the value of `height` is used | - -See [Payment options](https://experienceleague.adobe.com/en/docs/commerce/payment-services/payments-checkout/payments-options) for more information. - -### `GooglePayConfig` attributes - -The `GooglePayConfig` payment method configuration contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `code` | String | The payment method code as defined in the payment gateway | -| `is_visible` | Boolean | Indicates whether the payment method is shown | -| `payment_intent` | String | Defines the payment intent. The possible values are `Authorize` or `Capture` | -| `payment_source` | String | The identifiable payment source for the payment method | -| `sdk_params` | SDKParams | PayPal parameters required to load the PayPal JavaScript SDK | -| `sort_order` | String | The relative order the payment method is displayed on the checkout page | -| `title` | String! | The display name of the payment method | - -The possible values for `payment_source` are credit card (`cc`), PayPal (`paypal`), Google Pay (`googlepay`), and Apple Pay (`applepay`), depending on the payment method. - -The `GooglePayConfig` payment method configuration also has a `button_styles` object containing the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `color` | String | The button color | -| `height` | Int | The button height in pixels | -| `type` | String | Defines the button type. The possible values are `buy`, `checkout`, `order`, `pay`, and `plain` | - -See [Google Pay API request object options](https://developers.google.com/pay/api/web/reference/request-objects) documentation for more information. - -### `HostedFieldsConfig` attributes - -The `HostedFieldsConfig` payment method configuration contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `cc_vault_code` | String | The vault payment method code. Hosted fields only works with credit cards (cc) | -| `is_vault_enabled` | Boolean | Indicates whether card vaulting is enabled | -| `payment_source` | String | The identifiable payment source for the payment method | -| `requires_card_details` | Boolean | Indicates whether card and bin details are required. This value is true when the Signifyd integration is enabled for hosted fields | -| `three_ds_mode` | ThreeDSMode | Indicates which 3D Secure authentication mode is in use. The possible values are `OFF`, `SCA_WHEN_REQUIRED`, `SCA_ALWAYS` | - -**Note:** The `three_ds` attribute is deprecated. The `HostedFieldsConfig` payment method configuration currently uses a `three_ds_mode` attribute instead. - -### `SmartButtonsConfig` attributes - -The `SmartButtonsConfig` payment method configuration contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `button_styles` | ButtonStyles | The styles for the PayPal Smart Button configuration | -| `display_message` | Boolean | Indicates whether the PayPal Pay Later message is shown | -| `display_venmo` | Boolean | Defines if the Venmo option is shown | -| `message_styles` | MessageStyles | The message styles for the PayPal Pay Later configuration | - -See [Payment options](https://experienceleague.adobe.com/en/docs/commerce/payment-services/payments-checkout/payments-options) for more information. - -#### `ButtonStyles` object - -The `SmartButtonsConfig` payment method configuration has a `ButtonStyles` object containing the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `color` | String | The button color | -| `height` | Int | The button height in pixels | -| `label` | String | The button label | -| `layout` | String | The button layout | -| `shape` | String | The button shape | -| `tagline` | Boolean | Indicates whether to display the PayPal tagline | -| `use_default_height` | Boolean | Defines if button uses default height. If the value is `False`, the value of `height` is used | - -#### `MessageStyles` object - -The `SmartButtonsConfig` payment method configuration has a `MessageStyles` object containing the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `layout` | String | The message layout | -| `logo` | String | The message logo | - -#### `SDKParams` attributes - -The `SDKParams` object provides details about the SDK parameters: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `name` | String | The name of the SDK parameter | -| `value` | String | The value of the SDK parameter | - -These values come from [PayPal JavaScript SDK](https://developer.paypal.com/sdk/js/reference/). +[PayPal JavaScript SDK](https://developer.paypal.com/sdk/js/reference/) diff --git a/src/pages/graphql/payment-services-extension/queries/get-payment-order.md b/src/pages/graphql/payment-services-extension/queries/get-payment-order.md index 1837e2787..0276509e5 100644 --- a/src/pages/graphql/payment-services-extension/queries/get-payment-order.md +++ b/src/pages/graphql/payment-services-extension/queries/get-payment-order.md @@ -7,7 +7,7 @@ description: This query retrieves the payment details for the order. -This query is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.3.0 or higher. +This query is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this query. The `getPaymentOrder` query retrieves the payment details for the order. You must run the `getPaymentOrder` query when the Signifyd integration and `hosted_fields` are enabled in [Payment Services](https://experienceleague.adobe.com/en/docs/commerce/payment-services/payments-checkout/payments-options). @@ -24,7 +24,7 @@ The `getPaymentOrder` query retrieves the payment details for the order. You mus ## Reference -The [`getPaymentOrder`](/reference/graphql/index.md#getpaymentorder) reference provides detailed information about the types and fields defined in this query. +The [`getPaymentOrder`](/reference/graphql/saas/index.md#getpaymentorder) reference provides detailed information about the types and fields defined in this query. ## Example usage @@ -80,51 +80,3 @@ The following example runs the `getPaymentOrder` query: } } ``` - -## Input attributes - -The `getPaymentOrder` query must contain the following input attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `cartId` | String! | The unique ID of the cart | -| `id` | String! | The unique order ID generated by PayPal | - -## Output attributes - -The `PaymentOrderOutput` object contains the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `id` | String | The unique order ID generated by PayPal | -| `mp_order_id` | String | The unique order ID generated in Commerce if Payment Services is enabled after PayPal returns the `id` | -| `payment_source_details` | PaymentSourceDetails | The payment source details for the order | -| `status` | String | The status of the payment order. See [order status](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/order-management/orders/order-status) for more information | - -### `PaymentSourceDetails` attributes - -The `PaymentSourceDetails` object contains the payment details for the order for the type of payment source. Hosted fields only works with credit card. All child attributes are listed in alphabetical order. - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `card` | Card | The payment card details for the order | - -#### `Card` attributes - -The `PaymentSourceDetails` object has a `Card` object containing the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `bin_details` | CardBin | Card bin details | -| `card_expiry_month` | String | Expiry month on the card | -| `card_expiry_year` | String | Expiry year on the card | -| `last_digits` | String | Last digits of the card | -| `name` | String | Name on the card | - -#### `BinDetails` attributes - -The `bin_details` CardBin contains the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `bin` | String | Card bin number | diff --git a/src/pages/graphql/payment-services-extension/queries/get-payment-sdk.md b/src/pages/graphql/payment-services-extension/queries/get-payment-sdk.md index 545f46c69..3fd140688 100644 --- a/src/pages/graphql/payment-services-extension/queries/get-payment-sdk.md +++ b/src/pages/graphql/payment-services-extension/queries/get-payment-sdk.md @@ -7,7 +7,7 @@ description: This query retrieves the payment PayPal SDK URLs and other related -This query is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.3.0 or higher. +This query is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this query. The `getPaymentSDK` query gets the payment PayPal SDK URLs and other related values. @@ -23,7 +23,7 @@ The `getPaymentSDK` query gets the payment PayPal SDK URLs and other related val ## Reference -The [`getPaymentSDK`](/reference/graphql/index.md#getpaymentsdk) reference provides detailed information about the types and fields defined in this query. +The [`getPaymentSDK`](/reference/graphql/saas/index.md#getpaymentsdk) reference provides detailed information about the types and fields defined in this query. ## Example usage @@ -105,29 +105,3 @@ query { } } ``` - -## Input attributes - -The `getPaymentSDK` query must contain the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `location` | PaymentLocation! | The origin location for that payment request. The possible values are PRODUCT_DETAIL, MINICART, CART, CHECKOUT, ADMIN | - -## Output attributes - -The `GetPaymentSDKOutput` object must contain the following attributes: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `code` | String | The payment method code as defined in the payment gateway | -| `params` | [SDKParams] | PayPal parameters required to load JS SDK | - -### `SDKParams` object - -The `SDKParams` object provides details about the SDK parameters: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `name` | String! | The name of the SDK parameter | -| `value` | String! | The value of the SDK parameter | diff --git a/src/pages/graphql/payment-services-extension/queries/get-vault-config.md b/src/pages/graphql/payment-services-extension/queries/get-vault-config.md index 862f415b6..b5218a475 100644 --- a/src/pages/graphql/payment-services-extension/queries/get-vault-config.md +++ b/src/pages/graphql/payment-services-extension/queries/get-vault-config.md @@ -7,10 +7,12 @@ description: This query returns the vault configuration details for each payment -This query is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher. +This query is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher to use this query. The `getVaultConfig` query returns the vault configuration details for each payment method available. For now, only `credit_card` is supported. +See [PayPal JavaScript SDK](https://developer.paypal.com/sdk/js/reference/) for details about response values. + ## Syntax ```graphql @@ -21,7 +23,7 @@ The `getVaultConfig` query returns the vault configuration details for each paym ## Reference -The [`getVaultConfig`](/reference/graphql/index.md#getvaultconfig) reference provides detailed information about the types and fields defined in this query. +The [`getVaultConfig`](/reference/graphql/saas/index.md#getvaultconfig) reference provides detailed information about the types and fields defined in this query. ## Example usage @@ -76,32 +78,3 @@ query { } } ``` - -## Output attributes - -The `VaultConfigOutput` object contains the following attribute: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `credit_card` | VaultCreditCardConfig | Credit card vault method configuration | - -### `VaultCreditCardConfig` attributes - -The `VaultCreditCardConfig` object provides details about the credit card vault method configuration - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `is_vault_enabled` | Boolean | Indicates whether card vaulting is enabled | -| `three_ds_mode` | ThreeDSMode | Indicates which 3D Secure authentication mode is in use. The possible values are `OFF`, `SCA_WHEN_REQUIRED`, `SCA_ALWAYS` | -| `sdk_params` | [SDKParams] | PayPal parameters required to load the PayPal JavaScript SDK | - -#### `SDKParams` attributes - -The `SDKParams` object provides details about the SDK parameters: - -| Attribute | Data Type | Description | -| --- | --- | --- | -| `name` | String | The name of the SDK parameter | -| `value` | String | The value of the SDK parameter | - -These values come from [PayPal JavaScript SDK](https://developer.paypal.com/sdk/js/reference/).