Properties
| Name | Type | Description |
|---|---|---|
| id | string | Payment ID unique identifier in VTEX. |
| method | string | Payment method used for the buyer. |
| name | string | Payment name used for the buyer. This name could be the brand card or the VTEX payment method. |
| value | number | Payment value, with two decimal places separated by `.`. |
| currencyIso4217 | string | Currency used in each payment in the transaction, in ISO 4217 format. |
| installments | integer | Number of installments. |
| details | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Payment",
"title": "Payment",
"description": "Payment information.",
"required": [
"id",
"method",
"value",
"currencyIso4217",
"installments"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Payment ID unique identifier in VTEX.",
"example": "2D00FEBB"
},
"method": {
"type": "string",
"description": "Payment method used for the buyer.",
"example": "CreditCard"
},
"name": {
"type": "string",
"description": "Payment name used for the buyer. This name could be the brand card or the VTEX payment method.",
"example": "Visa"
},
"value": {
"type": "number",
"description": "Payment value, with two decimal places separated by `.`.",
"example": 63.98
},
"currencyIso4217": {
"type": "string",
"description": "Currency used in each payment in the transaction, in ISO 4217 format.",
"example": "BRL"
},
"installments": {
"type": "integer",
"description": "Number of installments.",
"example": 3
},
"details": {
"$ref": "#/components/schemas/Details"
}
}
}