VTEX · Schema

Settlement

Settlement transaction information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
href string Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.
View JSON Schema on GitHub

JSON Schema

vtex-settlement-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Settlement",
  "title": "Settlement",
  "type": "object",
  "description": "Settlement transaction information.",
  "required": [
    "href"
  ],
  "properties": {
    "href": {
      "type": "string",
      "description": "Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.",
      "example": "/gatewayqa/giftcards/3b1abc17-988e-4a14-8b7f-31fc6a5b955c_24/transactions/e122ebd4501a4b3b93640b7444ac425d/settlements"
    }
  }
}