VTEX · Example Payload

Vtex Closeanaccount Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Closeanaccount Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "CloseanAccount",
  "method": "DELETE",
  "path": "/api/creditcontrol/accounts/{creditAccountId}",
  "summary": "VTex Close an account",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "32222222222_CPF",
        "balance": 0,
        "document": "32222222222",
        "status": "Closed",
        "documentType": "CPF",
        "creditLimit": 500,
        "updatedAt": "2023-11-09T14:36:09.0201326Z",
        "createdAt": "2023-11-09T14:31:27.0775349Z",
        "description": "",
        "availableCredit": 500,
        "preAuthorizedCredit": 0,
        "email": "test3@teste.com",
        "tolerance": 1,
        "availableBalance": 500
      }
    }
  ]
}