VTEX · Schema
Success2
Settle payment response body information.
CommerceE-CommerceRetailMarketplacePayments
Properties
| Name | Type | Description |
|---|---|---|
| paymentId | string | The same `paymentId` sent in the request. |
| settleId | string | VTEX identifier for this settlement. |
| value | number | The amount to be settled. |
| code | string | Provider's operation/error code to be logged. |
| message | string | Provider's operation/error message to be logged. |
| requestId | string | The same `requestId` sent in the request. |
| connectorMetadata | array | Array containing metadata fields sent from the provider to the payment gateway. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Success2",
"title": "Success2",
"required": [
"paymentId",
"settleId",
"value",
"code",
"message",
"requestId"
],
"type": "object",
"description": "Settle payment response body information.",
"properties": {
"paymentId": {
"type": "string",
"description": "The same `paymentId` sent in the request."
},
"settleId": {
"type": "string",
"description": "VTEX identifier for this settlement."
},
"value": {
"type": "number",
"description": "The amount to be settled."
},
"code": {
"type": "string",
"nullable": true,
"description": "Provider's operation/error code to be logged."
},
"message": {
"type": "string",
"description": "Provider's operation/error message to be logged."
},
"requestId": {
"type": "string",
"description": "The same `requestId` sent in the request."
},
"connectorMetadata": {
"type": "array",
"description": "Array containing metadata fields sent from the provider to the payment gateway.",
"items": {
"type": "object",
"description": "Metadata fields information.",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the metadata to be stored in the gateway (limited to 20 characters)."
},
"value": {
"type": "string",
"description": "The value of the metadata stored (limited to 200 characters)."
}
}
}
}
}
}