VTEX · Schema

SettleResponse

Transaction response body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Settle request identification.
token string Token identification.
status number Status code.
statusDetail string Status detail information.
processingDate string Settlement processing date.
refundedValue integer Refunded value.
refundedToken string Refund operation token.
message string Custom message.
code string Custom code.
connectorRefundedValue number Refunded value by connector (provider).
cancelledValue integer Cancelled value.
View JSON Schema on GitHub

JSON Schema

vtex-settleresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SettleResponse",
  "title": "SettleResponse",
  "required": [
    "id",
    "token",
    "status",
    "statusDetail",
    "processingDate",
    "refundedValue",
    "refundedToken",
    "message",
    "code",
    "connectorRefundedValue",
    "cancelledValue"
  ],
  "type": "object",
  "description": " Transaction response body information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Settle request identification.",
      "nullable": true
    },
    "token": {
      "type": "string",
      "description": "Token identification."
    },
    "status": {
      "type": "number",
      "description": "Status code."
    },
    "statusDetail": {
      "type": "string",
      "description": "Status detail information."
    },
    "processingDate": {
      "type": "string",
      "description": "Settlement processing date."
    },
    "refundedValue": {
      "type": "integer",
      "description": "Refunded value."
    },
    "refundedToken": {
      "type": "string",
      "description": "Refund operation token.",
      "nullable": true
    },
    "message": {
      "type": "string",
      "description": "Custom message.",
      "nullable": true
    },
    "code": {
      "type": "string",
      "description": "Custom code.",
      "nullable": true
    },
    "connectorRefundedValue": {
      "type": "number",
      "description": "Refunded value by connector (provider)."
    },
    "cancelledValue": {
      "type": "integer",
      "description": "Cancelled value."
    }
  }
}