Beta Order Client Payment

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An order payment.",
  "properties": {
    "amount": {
      "description": "The amount of this payment.",
      "type": "number"
    },
    "billingPostalCode": {
      "description": "The billing address postal code. May be `null` for order payments\nmade prior to the introduction of this value.",
      "pattern": "^[A-Za-z0-9 -]{0,10}$",
      "type": "string"
    },
    "checkNumber": {
      "description": "If this payment was made by check, the check number for the payment.",
      "nullable": true,
      "type": "integer"
    },
    "created": {
      "description": "The date on which this payment was logged in the system.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "currencyCode": {
      "description": "Identifies the currency in which this payment was made. This is\nalways the currency of the order; it cannot be set when making a\npayment.",
      "readOnly": true,
      "type": "string"
    },
    "currencySymbol": {
      "description": "The currency symbol for the currency used for this payment.",
      "readOnly": true,
      "type": "string"
    },
    "emailAddress": {
      "description": "The email address for the person making the payment.",
      "format": "email",
      "type": "string"
    },
    "id": {
      "description": "The identifier for this order payment.",
      "type": "integer"
    },
    "isPaymentOnHold": {
      "description": "If `paymentFundsType` is \"credit-card\" and payment was made with\nShootProof Payments, this flag indicates whether the funds for this\npayment are currently on hold. This is typically the case during a\nfive-day period after credit payment was made, but before ShootProof\nreleases the profit to the Studio.\n\n* If `false`, the payment has been released.\n* If `null`, releasing of funds is not applicable such as when made\nwith cash/check, or a non-ShootProof Payments gateway, such as\nAuthorize.Net, Braintree, or PayPal Pro.\n* If either `isPaymentOnHold` or `isPaymentReleased` are non-null,\nonly one of them will be `true` at any point a time.",
      "nullable": true,
      "readOnly": true,
      "type": "boolean"
    },
    "isPaymentReleased": {
      "description": "If `paymentFundsType` is \"credit-card\" and payment was made with\nShootProof Payments, this flag indicates whether the funds from this\npayment have been released.\n\n* If `false`, the payment is still on hold.\n* If `null`, releasing of funds is not applicable such as when made\nwith cash/check, or a non-ShootProof Payments gateway, such as\nAuthorize.Net, Braintree, or PayPal Pro.\n* If either `isPaymentOnHold` or `isPaymentReleased` are non-null,\nonly one of them will be `true` at any point a time.",
      "nullable": true,
      "readOnly": true,
      "type": "boolean"
    },
    "isRefundable": {
      "description": "Whether the payment is able to be refunded.",
      "readOnly": true,
      "type": "boolean"
    },
    "nameOnCard": {
      "description": "The card-holder name.",
      "type": "string"
    },
    "note": {
      "description": "A note about the payment.",
      "nullable": true,
      "type": "string"
    },
    "paymentDate": {
      "description": "The date on which this payment was made.",
      "format": "date-time",
      "type": "string"
    },
    "paymentFundsType": {
      "description": "The type of funds received for this payment.",
      "enum": [
        "cash",
        "check",
        "credit-card",
        "invoice"
      ],
      "type": "string"
    },
    "paymentReleasedDate": {
      "description": "If `isPaymentReleased` is `true`, this indicates the date on which\nthe payment was released.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "order-payment"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "amount",
    "paymentFundsType",
    "paymentDate"
  ],
  "title": "Order Payment",
  "type": "object",
  "x-beta": true
}