Payment Methods

The PaymentMethod represents a reusable and structured model for storing payment method details.

It is designed to simplify integration with external Payment Service Providers (PSPs). It holds information about the PSP and the actual method used.

Representations

PaymentMethod

PaymentMethodDraft

PaymentMethodPagedQueryResponse

PaymentMethodReference

PaymentMethodStatus

PaymentMethodToken

PaymentMethod

`id` String	Unique identifier of the PaymentMethod.
`version` Int	Current version of the PaymentMethod.
`key` String	User-defined unique identifier of the PaymentMethod. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Name of the PaymentMethod.
`customer` CustomerReference	Reference to a Customer associated with the PaymentMethod. If `businessUnit` is set, the Customer is an Associate of the Business Unit.
`businessUnit` BusinessUnitKeyReference	Reference to a BusinessUnit associated with the PaymentMethod. Only available for B2B-enabled Projects.
`method` String	Payment Method used for the Payment—for example, a credit card or direct debit.
`paymentInterface` String	Payment service that processes the Payment—for example, a PSP.
`interfaceAccount` String	Account or instance of the payment interface when multiple accounts are used (per interface).
`token` PaymentMethodToken	Tokenized representation of the PaymentMethod used by the payment interface.
`paymentMethodStatus` PaymentMethodStatus	Status of the PaymentMethod. Default: `Active`
`default` Boolean	Indicates if the PaymentMethod is the default. The default applies per Customer, Business Unit, or the combination of both (Associate). Default: `false`
`custom` CustomFields	Custom Fields of the PaymentMethod.
`createdAt` DateTime	Date and time (UTC) the PaymentMethod was initially created.
`createdBy`BETA CreatedBy	IDs and references that created the PaymentMethod.
`lastModifiedAt` DateTime	Date and time (UTC) the PaymentMethod was last updated.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the PaymentMethod.

PaymentMethodDraft

`key` String	User-defined unique identifier for the PaymentMethod. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Name of the PaymentMethod.
`customer` CustomerResourceIdentifier	Reference to a Customer the PaymentMethod should belong to. If `businessUnit` is set, the Customer must be an Associate of the Business Unit.
`businessUnit` BusinessUnitResourceIdentifier	Reference to a BusinessUnit the PaymentMethod should belong to. Only available for B2B-enabled Projects.
`method` String	Payment method to use for the Payment—for example, a credit card or direct debit.
`paymentInterface` String	Payment service that processes the Payment—for example, a PSP.
`interfaceAccount` String	Account or instance of the payment interface when multiple accounts are used (per interface).
`token` PaymentMethodToken	Tokenized representation of the PaymentMethod used by the payment interface.
`paymentMethodStatus` PaymentMethodStatus	Status of the PaymentMethod. Default: `Active`
`default` Boolean	Set to `true` if the PaymentMethod should be the default. The default applies per Customer, Business Unit, or the combination of both (Associate). Default: `false`
`custom` CustomFieldsDraft	Custom Fields for the PaymentMethod.

PaymentMethodPagedQueryResponse

PagedQueryResult with results containing an array of PaymentMethod.

`limit` Int	Number of results requested. Default: `20`Minimum: `0`Maximum: `500`
`offset` Int	Number of elements skipped. Default: `0`Maximum: `10000`
`count` Int	Actual number of results returned.
`total` Int	Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`. When the results are filtered with a Query Predicate, `total` is subject to a limit.
`results` Array of PaymentMethod	PaymentMethods matching the query.

PaymentMethodReference

Reference to a PaymentMethod.

`id` String	Unique identifier of the referenced PaymentMethod.
`typeId` ReferenceTypeId	`payment-method` Type of referenced resource.
`obj` PaymentMethod	Contains the representation of the expanded PaymentMethod. Only present in responses to requests with Reference Expansion for PaymentMethods.

PaymentMethodStatus

Active: The PaymentMethod is active.
Inactive: The PaymentMethod is inactive.

PaymentMethodToken

The token value is sensitive, and we recommend that it is not logged when being handled in API Extensions.

value

String

Tokenized representation of the Payment Method.

It is displayed in the following instances:

in the payload of an API Extension for Payments and PaymentMethods
when querying Payments and PaymentMethods

It is masked in the following instances:

in the payload of Payment and PaymentMethod messages
when querying MyPayments
in referenced Payments and PaymentMethods embedded through Reference Expansion

Get PaymentMethod

Get PaymentMethod by ID

GET

https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id}

Retrieves a PaymentMethod with the provided id.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the PaymentMethod.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Get PaymentMethod by Key

GET

https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key}

Retrieves a PaymentMethod with the provided key.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the PaymentMethod.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Query PaymentMethods

GET

https://api.{region}.commercetools.com/{projectKey}/payment-methods

Retrieves all PaymentMethods in the Project.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested. Default: `20` Minimum: `0` Maximum: `500`
`offset` Int	Number of elements skipped. Default: `0` Maximum: `10000`
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed. Default: `true`
`var.<varName>` String	Predicate parameter values. The parameter can be passed multiple times.

Response:

200

PaymentMethodPagedQueryResponse

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/payment-methods -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: PaymentMethodPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 1,
  "total": 1,
  "results": [
    {
      "id": "c7555392-a14c-48c8-9021-73d5d302b562",
      "key": "my-payment-method",
      "version": 1,
      "versionModifiedAt": "2025-01-20T16:38:00.292Z",
      "lastMessageSequenceNumber": 1,
      "createdAt": "2025-01-20T16:38:00.292Z",
      "lastModifiedAt": "2025-01-20T16:38:00.292Z",
      "customer": {
        "id": "c7555392-a14c-48c8-9021-73d5d302b565",
        "typeId": "customer"
      },
      "businessUnit": {
        "key": "my-bu",
        "typeId": "business-unit"
      },
      "token": {
        "value": "PSPToken"
      },
      "method": "Card",
      "paymentInterface": "Adyen",
      "interfaceAccount": "adyen-merchant-eu",
      "default": true,
      "name": {
        "en": "my custom localised name"
      },
      "customFields": null,
      "paymentMethodStatus": "Active"
    }
  ]
}

Check if PaymentMethod exists

Check if PaymentMethod exists by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id}

Checks if a PaymentMethod exists with the provided id. Returns a 200 status if the PaymentMethod exists, or a 404 status otherwise.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the PaymentMethod.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if PaymentMethod exists by Key

HEAD

https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key}

Checks if a PaymentMethod exists with the provided key. Returns a 200 status if the PaymentMethod exists, or a 404 status otherwise.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the PaymentMethod.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if PaymentMethod exists by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/payment-methods

Checks if one or more PaymentMethods exist for the provided query predicate. Returns a 200 status if any PaymentMethods match the query predicate, or a 404 status otherwise.

OAuth 2.0 Scopes:

view_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

where

QueryPredicate

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/payment-methods -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Create PaymentMethod

POST

https://api.{region}.commercetools.com/{projectKey}/payment-methods

Creates a PaymentMethod in the Project. This request generates the PaymentMethodCreated Message.

OAuth 2.0 Scopes:

manage_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:PaymentMethodDraftasapplication/json

Response:

201

PaymentMethod

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/payment-methods -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "key" : "my-payment-method",
  "customer" : {
    "id" : "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId" : "customer"
  },
  "businessUnit" : {
    "key" : "my-bu",
    "typeId" : "business-unit"
  },
  "token" : {
    "value" : "PSPToken"
  },
  "method" : "Card",
  "paymentInterface" : "Adyen",
  "interfaceAccount" : "adyen-merchant-eu",
  "default" : true,
  "name" : {
    "en" : "my custom localised name"
  },
  "paymentMethodStatus" : "Active"
}
DATA

201 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Update PaymentMethod

Update PaymentMethod by ID

POST

https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id}

Updates a PaymentMethod in the Project using one or more update actions.

OAuth 2.0 Scopes:

manage_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the PaymentMethod.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the PaymentMethod on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of PaymentMethodUpdateAction	Update actions to be performed on the PaymentMethod.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "setPaymentMethodStatus",
    "paymentMethodStatus" : "Active"
  } ]
}
DATA

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Update PaymentMethod by Key

POST

https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key}

Updates a PaymentMethod in the Project using one or more update actions.

OAuth 2.0 Scopes:

manage_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the PaymentMethod.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the PaymentMethod on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of PaymentMethodUpdateAction	Update actions to be performed on the PaymentMethod.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "setPaymentMethodStatus",
    "paymentMethodStatus" : "Active"
  } ]
}
DATA

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Update actions

Set PaymentMethodStatus

Set Key

This action generates the PaymentMethodKeySet Message.

`action` String	`"setKey"`
`key` String	Value to set. If empty, any existing value will be removed. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`

Example: json

{
  "action": "setKey",
  "key": "payment-method-key"
}

Set Name

This update action generates the PaymentMethodNameSet Message.

`action` String	`"setName"`
`name` LocalizedString	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setName",
  "name": {
    "de": "German name",
    "en": "English name"
  }
}

Set Method

This action generates the PaymentMethodMethodSet Message.

`action` String	`"setMethod"`
`method` String	New payment method—for example, a credit card or direct debit. If empty, any existing value will be removed.

Example: json

{
  "action": "setMethod",
  "method": "newMethod"
}

Set Default

This action generates the PaymentMethodDefaultSet Message.

An inactive Payment Method cannot be set as the default, and the action will return an InvalidOperation error.

`action` String	`"setDefault"`
`default` Boolean	Value to set.

Example: json

{
  "action": "setDefault",
  "default": true
}

Set PaymentMethodStatus

This action generates the PaymentMethodPaymentMethodStatusSet Message.

A default Payment Method cannot be set as inactive, and the action will return an InvalidOperation error.

`action` String	`"setPaymentMethodStatus"`
`paymentMethodStatus` PaymentMethodStatus	Value to set.

Example: json

{
  "action": "setPaymentMethodStatus",
  "paymentMethodStatus": "Active"
}

Set PaymentInterface

This action generates the PaymentMethodPaymentInterfaceSet Message.

`action` String	`"setPaymentInterface"`
`paymentInterface` String	New payment service that processes the Payment—for example, a PSP. If empty, any existing value will be removed.

Example: json

{
  "action": "setPaymentInterface",
  "paymentInterface": "newInterface"
}

Set InterfaceAccount

This action generates the PaymentMethodInterfaceAccountSet Message.

`action` String	`"setInterfaceAccount"`
`interfaceAccount` String	New account or instance of the payment interface. If empty, any existing value will be removed.

Example: json

{
  "action": "setInterfaceAccount",
  "interfaceAccount": "newInterfaceAccount"
}

Set Custom Type

Adding or updating a Custom Type on a PaymentMethod generates the PaymentMethodCustomTypeSet Message, removing one generates the PaymentMethodCustomTypeRemoved Message.

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the PaymentMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the PaymentMethod.
`fields` FieldContainer	Sets the Custom Fields fields for the PaymentMethod.

Example: json

{
  "action": "setCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringField": "TextString"
  }
}

Set CustomField

Adding a Custom Field to a PaymentMethod generates the PaymentMethodCustomFieldAdded Message, removing one generates the PaymentMethodCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodCustomFieldChanged Message.

`action` String	`"setCustomField"`
`name` String	Name of the Custom Field to add, update, or remove.
`value` CustomFieldValue	If `value` is absent or `null`, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action": "setCustomField",
  "name": "exampleStringField",
  "value": "TextString"
}

Delete PaymentMethod

Delete PaymentMethod by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id}

Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted Message.

OAuth 2.0 Scopes:

manage_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the PaymentMethod.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payment-methods/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Delete PaymentMethod by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key}

Deletes a PaymentMethod in the Project. This request generates the PaymentMethodDeleted Message.

OAuth 2.0 Scopes:

manage_payment_methods:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the PaymentMethod.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200

PaymentMethod

asapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payment-methods/key={key}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: PaymentMethodjson

{
  "id": "c7555392-a14c-48c8-9021-73d5d302b562",
  "key": "my-payment-method",
  "version": 1,
  "versionModifiedAt": "2025-01-20T16:38:00.292Z",
  "lastMessageSequenceNumber": 1,
  "createdAt": "2025-01-20T16:38:00.292Z",
  "lastModifiedAt": "2025-01-20T16:38:00.292Z",
  "customer": {
    "id": "c7555392-a14c-48c8-9021-73d5d302b565",
    "typeId": "customer"
  },
  "businessUnit": {
    "key": "my-bu",
    "typeId": "business-unit"
  },
  "token": {
    "value": "PSPToken"
  },
  "method": "Card",
  "paymentInterface": "Adyen",
  "interfaceAccount": "adyen-merchant-eu",
  "default": true,
  "name": {
    "en": "my custom localised name"
  },
  "customFields": null,
  "paymentMethodStatus": "Active"
}

Payment Methods

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethod.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethodDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethodPagedQueryResponse.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethodReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethodStatus.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentMethodToken.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get PaymentMethod.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get PaymentMethod by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Get PaymentMethod by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Query PaymentMethods.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Check if PaymentMethod exists.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Check if PaymentMethod exists by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Check if PaymentMethod exists by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Check if PaymentMethod exists by Query Predicate.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Create PaymentMethod.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update PaymentMethod.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update PaymentMethod by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update PaymentMethod by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Update actions.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set Name.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set Method.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set Default.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set PaymentMethodStatus.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set PaymentInterface.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set InterfaceAccount.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set Custom Type.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Set CustomField.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete PaymentMethod.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete PaymentMethod by ID.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Delete PaymentMethod by Key.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Representations

PaymentMethod

PaymentMethodDraft

PaymentMethodPagedQueryResponse

PaymentMethodReference

PaymentMethodStatus

PaymentMethodToken

Get PaymentMethod

Get PaymentMethod by ID

Get PaymentMethod by Key

Query PaymentMethods

Check if PaymentMethod exists

Check if PaymentMethod exists by ID

Check if PaymentMethod exists by Key

Check if PaymentMethod exists by Query Predicate

Create PaymentMethod

Update PaymentMethod

Update PaymentMethod by ID

Update PaymentMethod by Key

Update actions

Set Key

Set Name

Set Method

Set Default

Set PaymentMethodStatus

Set PaymentInterface

Set InterfaceAccount

Set Custom Type

Set CustomField

Delete PaymentMethod

Delete PaymentMethod by ID

Delete PaymentMethod by Key