VTEX · Example Payload

Vtex Openanaccount Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Openanaccount 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": "OpenanAccount",
  "method": "POST",
  "path": "/api/creditcontrol/accounts",
  "summary": "VTex Open an account",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "11111111111_CPF",
        "balance": 0,
        "document": "11111111111",
        "status": "Open",
        "documentType": "CPF",
        "creditLimit": 1100,
        "updatedAt": "2023-11-09T13:29:01.2505088Z",
        "createdAt": "2023-11-09T13:29:01.1567887Z",
        "description": "",
        "availableCredit": 1100,
        "preAuthorizedCredit": 0,
        "email": "ricardo@teste.com.br",
        "tolerance": 0.2,
        "availableBalance": 1100
      }
    }
  ]
}