A Payment represents a series of logically connected financial transactions like reserving, charging, or refunding money.
Representations
Payment
id ​String​ | Unique identifier of the Payment. |
version ​Int​ | Current version of the Payment. |
key ​String​ | User-defined unique identifier of the Payment. MinLength:Â2 ​MaxLength: 256 ​Pattern: ^[A-Za-z0-9_-]+$ ​ |
customer ​ | Reference to a Customer associated with the Payment. |
anonymousId ​String​ | Anonymous session associated with the Payment. |
interfaceId ​String​ | Identifier used by the payment service that processes the Payment (for example, a PSP).
The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique. |
amountPlanned ​ | |
paymentMethodInfo ​ | Information regarding the payment interface (for example, a PSP), and the specific payment method used. |
paymentStatus ​ | Current status of the Payment. |
transactions ​Array of Transaction​ | Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState. |
interfaceInteractions ​Array of CustomFields​ | Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service. |
custom ​CustomFields​ | Custom Fields for the Payment. |
createdAt ​DateTime​ | Date and time (UTC) the Payment was initially created. |
createdBy ​BETACreatedBy​ | IDs and references that created the Payment. |
lastModifiedAt ​DateTime​ | Date and time (UTC) the Payment was last updated. |
lastModifiedBy ​BETA | IDs and references that last modified the Payment. |
PaymentDraft
key ​String​ | User-defined unique identifier for the Payment. MinLength:Â2 ​MaxLength: 256 ​Pattern: ^[A-Za-z0-9_-]+$ ​ |
customer ​ | Reference to a Customer associated with the Payment. |
anonymousId ​String​ | Anonymous session associated with the Payment. |
interfaceId ​String​ | Identifier used by the payment service that processes the Payment (for example, a PSP).
The combination of interfaceId and the paymentInterface field on PaymentMethodInfo must be unique.
Once set, it cannot be changed. |
amountPlanned ​Money​ | |
paymentMethodInfo ​ | Information regarding the payment interface (for example, a PSP), and the specific payment method used. |
paymentStatus ​ | Current status of the Payment. |
transactions ​Array of TransactionDraft​ | Financial transactions of the Payment. Each Transaction has a TransactionType and a TransactionState. |
interfaceInteractions ​Array of CustomFieldsDraft​ | Represents information exchange with the payment service, for example, a PSP. An interaction may be a request sent, or a response or notification received from the payment service. |
custom ​ | Custom Fields for the Payment. |
PaymentPagedQueryResponse
limit ​Int​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
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. |
offset ​Int​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
results ​Array of Payment​ | Payments matching the query. |
PaymentReference
id ​String​ | Unique identifier of the referenced Payment. |
typeId ​ | payment Type of referenced resource. |
obj ​Payment​ | Contains the representation of the expanded Payment. Only present in responses to requests with Reference Expansion for Payments. |
PaymentResourceIdentifier
id
or key
is required. If both are set, an InvalidJsonInput error is returned.id ​String​ | Unique identifier of the referenced Payment. Required if key is absent. |
key ​String​ | User-defined unique identifier of the referenced Payment. Required if id is absent. |
typeId ​ | payment Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource. |
PaymentMethodInfo
paymentInterface ​String​ | Payment service that processes the Payment (for example, a PSP).
Once set, it cannot be changed.
The combination of paymentInterface and the interfaceId of a Payment must be unique. |
method ​String​ | Payment method used, for example, credit card, or cash advance. |
name ​ | Localizable name of the payment method. |
PaymentStatus
interfaceCode ​String​ | External reference that identifies the current status of the Payment. |
interfaceText ​String​ | Text describing the current status of the Payment. |
state ​ |
PaymentStatusDraft
interfaceCode ​String​ | External reference that identifies the current status of the Payment. |
interfaceText ​String​ | Text describing the current status of the Payment. |
state ​ | ResourceIdentifier to a State. |
Transaction
Represents a financial transaction typically created as a result of a notification from the payment service.
id ​String​ | Unique identifier of the Transaction. |
timestamp ​DateTime​ | Date and time (UTC) the Transaction took place. |
type ​ | Type of the Transaction. For example, Authorization . |
amount ​ | Money value of the Transaction. |
interactionId ​String​ | Identifier used by the interface that manages the Transaction (usually the PSP).
If a matching interaction was logged in the interfaceInteractions array, the corresponding interaction can be found with this ID. |
state ​ | State of the Transaction. |
custom ​CustomFields​ | Custom Fields defined for the Transaction. |
TransactionDraft
timestamp ​DateTime​ | Date and time (UTC) the Transaction took place. |
type ​ | Type of the Transaction. |
amount ​Money​ | Money value for the Transaction. |
interactionId ​String​ | Identifier used by the payment service that manages the Transaction. Can be used to correlate the Transaction to an interface interaction. |
state ​ | State of the Transaction. Default:ÂInitial ​ |
custom ​ | Custom Fields of the Transaction. |
TransactionType
Authorization
Financially reliable reservation of an amount. Typically does not indicate an actual transfer of money.
CancelAuthorization
Explicit cancellation of an authorized amount before its expiry.
Charge
Collection of money from the customer. Can use an authorized amount or be directly executed.
Refund
Explicit transfer of money back to the customer.
Chargeback
Customer-initiated transfer of money back to the customer.
TransactionState
Transactions can be in one of the following States:
Initial
Initial State. The payment service has not accepted the Transaction yet.
Pending
The payment service has accepted the Transaction, but it is not completed yet.
Success
The payment service has confirmed the successful completion of the Transaction.
Failure
Transaction has unrecoverably failed.
Get Payment
Get Payment by ID
id
.view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the Payment. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/payments/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Get Payment by Key
key
.view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the Payment. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/payments/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Query Payments
Retrieves Payments in the Project.
view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | 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. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/payments -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"limit": 20,
"offset": 0,
"count": 1,
"total": 1,
"results": [
{
"id": "459e32dc-74ef-4189-bbd0-932275bb027c",
"version": 1,
"key": "123456",
"interfaceId": "78901",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "2e318aa5-8af4-4db1-909d-e7142f7d174f",
"timestamp": "2015-10-20T08:51:56.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:51:43.082Z",
"lastModifiedAt": "2015-10-20T08:51:43.082Z"
}
]
}
Check if Payment exists
Check if Payment exists by ID
id
. Returns a 200 OK
status if the Payment exists, or Not Found otherwise.view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the Payment. |
curl --head https://api.{region}.commercetools.com/{projectKey}/payments/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if Payment exists by Key
key
. Returns a 200 OK
status if the Payment exists, or Not Found otherwise.view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the Payment. |
curl --head https://api.{region}.commercetools.com/{projectKey}/payments/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if Payment exists by Query Predicate
200 OK
status if any Payments match the query predicate, or Not Found otherwise.view_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
where | The parameter can be passed multiple times. |
curl --head https://api.{region}.commercetools.com/{projectKey}/payments -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Create Payment
manage_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
expand | The parameter can be passed multiple times. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/payments -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"key" : "123456",
"interfaceId" : "789011",
"amountPlanned" : {
"currencyCode" : "USD",
"centAmount" : 1000
},
"paymentMethodInfo" : {
"paymentInterface" : "STRIPE",
"method" : "CREDIT_CARD",
"name" : {
"en" : "Credit Card"
}
},
"transactions" : [ {
"timestamp" : "2015-10-20T08:54:24.000Z",
"type" : "Charge",
"amount" : {
"currencyCode" : "USD",
"centAmount" : 1000
},
"state" : "Pending"
} ]
}
DATA
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Update Payment
Update Payment by ID
manage_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the Payment. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the Payment 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 PaymentUpdateAction​ | Update actions to be performed on the Payment. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/payments/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "transitionState",
"state" : {
"typeId" : "state",
"id" : "18748fe6-7f77-456a-96c8-913b1e4bbc9c"
}
} ]
}
DATA
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Update Payment by Key
manage_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the Payment. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the Payment 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 PaymentUpdateAction​ | Update actions to be performed on the Payment. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/payments/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "transitionState",
"state" : {
"typeId" : "state",
"id" : "18748fe6-7f77-456a-96c8-913b1e4bbc9c"
}
} ]
}
DATA
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Update actions
Set Key
action ​String​ | "setKey" |
key ​String​ | Value to set.
If MinLength: key is absent or null , the existing key, if any, will be removed.2 ​MaxLength: 256 ​Pattern: ^[A-Za-z0-9_-]+$ ​ |
{
"action": "setKey",
"key": "String"
}
Change AmountPlanned
action ​String​ | "changeAmountPlanned" |
amount ​Money​ | New value to set. |
{
"action": "changeAmountPlanned",
"amount": {
"currencyCode": "EUR",
"centAmount": 4000
}
}
Set Customer
action ​String​ | "setCustomer" |
customer ​ | Value to set. If empty, any existing reference is removed. |
{
"action": "setCustomer",
"customer": {
"typeId": "customer",
"id": "{{customer-id}}"
}
}
Set AnonymousId
action ​String​ | "setAnonymousId" |
anonymousId ​String​ | Value to set. If empty, any existing value will be removed. |
{
"action": "setAnonymousId",
"anonymousId": "anonymousId"
}
Set InterfaceId
action ​String​ | "setInterfaceId" |
interfaceId ​String​ | Value to set.
Once set, the interfaceId cannot be changed. |
{
"action": "setInterfaceId",
"interfaceId": "InterfaceID"
}
Set MethodInfoInterface
action ​String​ | "setMethodInfoInterface" |
interface ​String​ | Value to set.
Once set, the paymentInterface of the paymentMethodInfo cannot be changed. |
{
"action": "setMethodInfoInterface",
"interface": "MethodInfoInterfaceString"
}
Set MethodInfoMethod
action ​String​ | "setMethodInfoMethod" |
method ​String​ | Value to set. If empty, any existing value will be removed. |
{
"action": "setMethodInfoMethod",
"method": "MethodInfoMethodString"
}
Set MethodInfoName
action ​String​ | "setMethodInfoName" |
name ​ | Value to set. If empty, any existing value will be removed. |
{
"action": "setMethodInfoName",
"name": {
"de": "MethodInfoNameStringDE",
"en": "MethodInfoNameStringEN"
}
}
Set StatusInterfaceCode
action ​String​ | "setStatusInterfaceCode" |
interfaceCode ​String​ | Value to set. If empty, any existing value will be removed. |
{
"action": "setStatusInterfaceCode",
"interfaceCode": "InterfaceCodeString"
}
Set StatusInterfaceText
action ​String​ | "setStatusInterfaceText" |
interfaceText ​String​ | Value to set. If empty, any existing value will be removed. |
{
"action": "setStatusInterfaceText",
"interfaceText": "InterfaceTextString"
}
Transition State
initial
must be true
for the new State.
If the existing State has transitions set, the new State must be a valid transition.
If the existing State has no transitions set, no validations are performed when transitioning to the new State.action ​String​ | "transitionState" |
state ​ | ResourceIdentifier to a State. |
force ​Boolean​ | Set to true to skip validations when transitioning to the new State. |
{
"action": "transitionState",
"state": {
"typeId": "state",
"id": "{{paymentStateId}}"
}
}
Add Transaction
action ​String​ | "addTransaction" |
transaction ​ | Value to append to the transactions array. |
{
"action": "addTransaction",
"transaction": {
"type": "Authorization",
"amount": {
"centAmount": 4000,
"currencyCode": "EUR"
}
}
}
Change TransactionState
action ​String​ | "changeTransactionState" |
transactionId ​String​ | Unique identifier of the Transaction. |
state ​ | New TransactionState. |
{
"action": "changeTransactionState",
"transactionId": "{{transactionId}}",
"state": "Failure"
}
Change TransactionTimestamp
action ​String​ | "changeTransactionTimestamp" |
transactionId ​String​ | Unique identifier of the Transaction. |
timestamp ​DateTime​ | Timestamp of the Transaction as reported by the payment service. |
{
"action": "changeTransactionTimestamp",
"transactionId": "{{transactionId}}",
"timestamp": "2018-10-12T14:00:00.000Z"
}
Change TransactionInteractionId
action ​String​ | "changeTransactionInteractionId" |
transactionId ​String​ | Unique identifier of the Transaction. |
interactionId ​String​ | New value to set. |
{
"action": "changeTransactionInteractionId",
"transactionId": "{{transactionId}}",
"interactionId": "{{newInteractionId}}"
}
Add InterfaceInteraction
action ​String​ | "addInterfaceInteraction" |
type ​ | ResourceIdentifier of a Type. |
fields ​ |
{
"action": "addInterfaceInteraction",
"type": {
"typeId": "type",
"id": "{{type-id}}"
}
}
Set Custom Type
action ​String​ | "setCustomType" |
type ​ | Defines the Type that extends the Payment with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Payment. |
fields ​ | Sets the Custom Fields fields for the Payment. |
{
"action": "setCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}
Set CustomField
action ​String​ | "setCustomField" |
name ​String​ | Name of the Custom Field. |
value ​ | If value is absent or null , this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name . |
{
"action": "setCustomField",
"name": "exampleStringField",
"value": "TextString"
}
Set Transaction Custom Type
action ​String​ | "setTransactionCustomType" |
transactionId ​String​ | Unique identifier of the Transaction. If the specified transactionId does not exist, the request will fail with an InvalidOperation error. |
type ​ | Defines the Type that extends the Transaction with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the Transaction. |
fields ​ | Sets the Custom Fields fields for the Transaction. |
{
"action": "setTransactionCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
},
"transactionId": "transactionIdTest"
}
Set Transaction CustomField
action ​String​ | "setTransactionCustomField" |
transactionId ​String​ | Unique identifier of the Transaction. |
name ​String​ | Name of the Custom Field. |
value ​ | If value is absent or null , this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name . |
{
"action": "setTransactionCustomField",
"name": "exampleStringField",
"value": "TextString",
"transactionId": "transactionIdTest"
}
Delete Payment
Delete Payment by ID
Deletes a Payment in the Project.
manage_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the Payment. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payments/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}
Delete Payment by Key
Deletes a Payment in the Project.
manage_payments:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the Payment. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/payments/key={key}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "776f9240-09e1-4416-a34f-32fa80f0333f",
"version": 1,
"key": "123456",
"interfaceId": "789011",
"amountPlanned": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"paymentMethodInfo": {
"paymentInterface": "STRIPE",
"method": "CREDIT_CARD",
"name": {
"en": "Credit Card"
}
},
"paymentStatus": {
},
"transactions": [
{
"id": "14748fe6-7f77-456a-96c8-913b1e4bbc9a",
"timestamp": "2015-10-20T08:54:24.000Z",
"type": "Charge",
"amount": {
"type": "centPrecision",
"fractionDigits": 2,
"currencyCode": "USD",
"centAmount": 1000
},
"state": "Pending"
}
],
"interfaceInteractions": [],
"createdAt": "2015-10-20T08:54:11.480Z",
"lastModifiedAt": "2015-10-20T08:54:11.480Z"
}