# Checkout Payment Integrations API The Payment Integrations API lets you set up and manage payment method settings for your Checkout applications without relying on manual configuration in the Merchant Center. It makes it easier to configure and update payment methods in a scalable and automated way. With this API, you can enable or disable payment methods, keep settings consistent across multiple Stores or Regions, and make changes such as adding new payment methods or updating payment predicates. The Checkout [Application API](https://docs.commercetools.com/checkout/applications-api.md) and the Payment Integrations API are meant to be used together when creating a new Checkout application: the Checkout Application API defines the application itself, and the Payment Integrations API configures its payment methods. For updates, you can use each API separately to modify only the part of the Checkout application you need. A maximum of 100 Payment Integrations can be added to an Application. [Learn more about platform limits](https://docs.commercetools.com/checkout/limits.md#payment-integrations). ## Representations #### PaymentIntegration See API type definition [PaymentIntegration](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentIntegration). #### PaymentIntegration Draft See API type definition [PaymentIntegrationDraft](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentIntegrationDraft). #### Application Reference See API type definition [ApplicationReference](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationReference). #### ConnectorDeployment Reference See API type definition [ConnectorDeploymentReference](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3AConnectorDeploymentReference). #### DisplayInfo See API type definition [DisplayInfo](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ADisplayInfo). #### SortingInfo See API type definition [SortingInfo](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASortingInfo). #### AutomatedReversalConfiguration See API type definition [AutomatedReversalConfiguration](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3AAutomatedReversalConfiguration). #### PaymentComponentType See API type definition [PaymentComponentType](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentComponentType). #### PaymentIntegrationReference See API type definition [PaymentIntegrationReference](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentIntegrationReference). #### PaymentIntegrationResourceIdentifier See API type definition [PaymentIntegrationResourceIdentifier](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentIntegrationResourceIdentifier). #### PaymentIntegrationStatus See API type definition [PaymentIntegrationStatus](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3APaymentIntegrationStatus). ## Get PaymentIntegration ### Get PaymentIntegration by ID See API endpoint definition [GET /\{projectKey}/payment-integrations/\{id}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2F%7Bid%7D%3AGET). ### Get PaymentIntegration by Key See API endpoint definition [GET /\{projectKey}/payment-integrations/key=\{key}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2Fkey%3D%7Bkey%7D%3AGET). ## Query PaymentIntegrations See API endpoint definition [GET /\{projectKey}/payment-integrations](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%3AGET). ## Check if PaymentIntegration exists ### Check if PaymentIntegration exists by ID See API endpoint definition [HEAD /\{projectKey}/payment-integrations/\{id}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2F%7Bid%7D%3AHEAD). ### Check if PaymentIntegration exists by Key See API endpoint definition [HEAD /\{projectKey}/payment-integrations/key=\{key}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2Fkey%3D%7Bkey%7D%3AHEAD). ## Create PaymentIntegration See API endpoint definition [POST /\{projectKey}/payment-integrations](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%3APOST). ## Update PaymentIntegration ### Update PaymentIntegration by ID See API endpoint definition [POST /\{projectKey}/payment-integrations/\{id}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2F%7Bid%7D%3APOST). ### Update PaymentIntegration by Key See API endpoint definition [POST /\{projectKey}/payment-integrations/key=\{key}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2Fkey%3D%7Bkey%7D%3APOST). ## Update actions The following update actions allow you to modify specific properties of a Payment Integration resource. Use them with the update endpoints as described above. #### Set Key See API type definition [SetKeyUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetKeyUpdateAction). #### Set Name See API type definition [SetNameUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetNameUpdateAction). #### Set Type See API type definition [SetTypeUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetTypeUpdateAction). #### Set Status See API type definition [SetStatusUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetStatusUpdateAction). #### Set Predicate See API type definition [SetPredicateUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetPredicateUpdateAction). #### Set Display Info See API type definition [SetDisplayInfoUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetDisplayInfoUpdateAction). #### Set Display Info Label See API type definition [SetDisplayInfoLabelUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetDisplayInfoLabelUpdateAction). #### Set Display Info Logo URL See API type definition [SetDisplayInfoLogoUrlUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetDisplayInfoLogoUrlUpdateAction). #### Set Display Info Description See API type definition [SetDisplayInfoDescriptionUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetDisplayInfoDescriptionUpdateAction). #### Set Display Info Pay Button Text See API type definition [SetDisplayInfoPayButtonTextUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetDisplayInfoPayButtonTextUpdateAction). #### Set Sorting Info See API type definition [SetSortingInfoUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetSortingInfoUpdateAction). #### Set Automated Reversal Configuration See API type definition [SetAutomatedReversalConfigurationUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetAutomatedReversalConfigurationUpdateAction). #### Set Automated Reversal Configuration Status See API type definition [SetAutomatedReversalConfigurationStatusUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetAutomatedReversalConfigurationStatusUpdateAction). #### Set Automated Reversal Configuration Predicate See API type definition [SetAutomatedReversalConfigurationPredicateUpdateAction](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Atype%3ASetAutomatedReversalConfigurationPredicateUpdateAction). ## Delete PaymentIntegration ### Delete PaymentIntegration by Key See API endpoint definition [DELETE /\{projectKey}/payment-integrations/key=\{key}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2Fkey%3D%7Bkey%7D%3ADELETE). ### Delete PaymentIntegration by ID See API endpoint definition [DELETE /\{projectKey}/payment-integrations/\{id}](https://docs.commercetools.com/checkout/payment-integrations-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fpayment-integrations%2F%7Bid%7D%3ADELETE). ## Allowed SortList When querying Payment Integrations, you can sort the results using the `sort` query parameter. The following fields are available for sorting: (a CSV formatted table follows. The first line are the column names.) Field,Description,Example `id`,Sort by Payment Integration ID,`id asc` `name`,Sort by Payment Integration name,`name desc` `type`,Sort by Payment Integration type (card, paypal, etc.),`type asc` `status`,Sort by Payment Integration status (Active, Inactive),`status desc` `key`,Sort by Payment Integration key,`key asc` `componentType`,Sort by component type (Component, DropIn),`componentType asc` `createdAt`,Sort by creation timestamp,`createdAt desc` `lastModifiedAt`,Sort by last modification timestamp,`lastModifiedAt asc` `sortingInfo.priority`,Sort by sorting priority,`sortingInfo.priority asc` #### Sorting Examples Basic sorting: ``` GET /payment-integrations?sort=name asc GET /payment-integrations?sort=createdAt desc ``` Multiple sort criteria: ``` GET /payment-integrations?sort=status asc&sort=createdAt desc ``` Sorting by priority: ``` GET /payment-integrations?sort=sortingInfo.priority asc ``` Sorting with pagination: ``` GET /payment-integrations?sort=lastModifiedAt desc&limit=10&offset=0 ``` ## Related pages - [Section overview page](https://docs.commercetools.com/checkout.md) - [Previous page: Applications](https://docs.commercetools.com/checkout/applications-api.md) - [Next page: Payment Intents](https://docs.commercetools.com/checkout/payment-intents-api.md)