commercetools · Schema

Payment

A payment resource tracking financial transactions and PSP interactions for an order.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name Type Description
id string System-generated unique identifier.
version integer Current version for optimistic concurrency control.
key string User-defined unique identifier.
customer object
interfaceId string Payment identifier as reported by the PSP.
amountPlanned object
paymentMethodInfo object
paymentStatus object
transactions array List of financial transactions associated with this payment.
createdAt string ISO 8601 timestamp when the payment was created.
lastModifiedAt string ISO 8601 timestamp when the payment was last modified.
View JSON Schema on GitHub

JSON Schema

commercetools-payment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payment",
  "title": "Payment",
  "type": "object",
  "description": "A payment resource tracking financial transactions and PSP interactions for an order.",
  "required": [
    "id",
    "version",
    "amountPlanned",
    "paymentMethodInfo",
    "transactions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "System-generated unique identifier."
    },
    "version": {
      "type": "integer",
      "description": "Current version for optimistic concurrency control."
    },
    "key": {
      "type": "string",
      "description": "User-defined unique identifier."
    },
    "customer": {
      "$ref": "#/components/schemas/Reference"
    },
    "interfaceId": {
      "type": "string",
      "description": "Payment identifier as reported by the PSP."
    },
    "amountPlanned": {
      "$ref": "#/components/schemas/Money"
    },
    "paymentMethodInfo": {
      "$ref": "#/components/schemas/PaymentMethodInfo"
    },
    "paymentStatus": {
      "$ref": "#/components/schemas/PaymentStatus"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Transaction"
      },
      "description": "List of financial transactions associated with this payment."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the payment was created."
    },
    "lastModifiedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the payment was last modified."
    }
  }
}