commercetools · Schema

PaymentStatus

The current status of a payment including PSP-specific state information.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name Type Description
interfaceCode string PSP-specific status code.
interfaceText string PSP-specific status message.
state object
View JSON Schema on GitHub

JSON Schema

commercetools-paymentstatus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentStatus",
  "title": "PaymentStatus",
  "type": "object",
  "description": "The current status of a payment including PSP-specific state information.",
  "properties": {
    "interfaceCode": {
      "type": "string",
      "description": "PSP-specific status code."
    },
    "interfaceText": {
      "type": "string",
      "description": "PSP-specific status message."
    },
    "state": {
      "$ref": "#/components/schemas/Reference"
    }
  }
}