PaymentDraft

Request body for creating a new payment.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name	Type	Description
key	string	User-defined unique key for the payment.
customer	object
interfaceId	string	PSP payment identifier.
amountPlanned	object
paymentMethodInfo	object
transactions	array	Initial transactions to create with the payment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentDraft",
  "title": "PaymentDraft",
  "type": "object",
  "description": "Request body for creating a new payment.",
  "required": [
    "amountPlanned"
  ],
  "properties": {
    "key": {
      "type": "string",
      "description": "User-defined unique key for the payment."
    },
    "customer": {
      "$ref": "#/components/schemas/Reference"
    },
    "interfaceId": {
      "type": "string",
      "description": "PSP payment identifier."
    },
    "amountPlanned": {
      "$ref": "#/components/schemas/Money"
    },
    "paymentMethodInfo": {
      "$ref": "#/components/schemas/PaymentMethodInfo"
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Initial transactions to create with the payment."
    }
  }
}