VTEX · Schema
Success4
Inbound Request response body information.
CommerceE-CommerceRetailMarketplacePayments
Properties
| Name | Type | Description |
|---|---|---|
| requestId | string | The same `requestId` sent in the request. |
| paymentId | string | The same `paymentId` sent in the request. |
| code | string | Provider's operation/error code to be logged. |
| message | string | Provider's operation/error message to be logged. |
| responseData | object | |
| 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/Success4",
"title": "Success4",
"required": [
"requestId",
"paymentId",
"responseData"
],
"type": "object",
"description": "Inbound Request response body information.",
"properties": {
"requestId": {
"type": "string",
"description": "The same `requestId` sent in the request."
},
"paymentId": {
"type": "string",
"description": "The same `paymentId` sent in the request."
},
"code": {
"type": "string",
"description": "Provider's operation/error code to be logged."
},
"message": {
"type": "string",
"description": "Provider's operation/error message to be logged."
},
"responseData": {
"$ref": "#/components/schemas/ResponseData"
},
"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).",
"example": "MetadataName"
},
"value": {
"type": "string",
"description": "The value of the metadata stored (limited to 200 characters).",
"example": "MetadataValue"
}
}
}
}
}
}