Sign in

v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Estabelecimentos

Atualizar estabelecimento

put/v1/marketplace/establishments/{id}

Path parameters

idnumber required

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Request body

access_type'ACQUIRER' | 'BANKING'

Tipo de acesso.

first_namestring

Nome / razão social.

last_namestring nullable

Sobrenome / nome fantasia.

phone_numberstring

Número de telefone.

revenuenumber

Faturamento.

format'SS' | 'SC' | 'SPE' | 'LTDA' | 'SA' | 'ME' | 'MEI' | 'EI' | 'EIRELI' | 'SLU' | 'ESI'

Formato da empresa.

emailstring

E-mail.

gmvnumber

Meta de faturamento.

birthdatestring date-time

Data de nascimento / data de abertura.

Response

idnumber required

Identificador do estabelecimento.

type'INDIVIDUAL' | 'BUSINESS' required

Tipo - BUSINESS: pessoa jurídica. - INDIVIDUAL: pessoa física.

first_namestring required

Nome / Razão social.

last_namestring required

Sobrenome / Nome fantasia.

documentstring required

CPF / CNPJ.

birthdatestring date-time required

Data de nascimento / Data de abertura.

phone_numberstring required

Número de telefone.

activeboolean required

Indica se o estabelecimento está credenciado ou não.

revenuestring required

Faturamento.

format'SS' | 'SC' | 'SPE' | 'LTDA' | 'SA' | 'ME' | 'MEI' | 'EI' | 'EIRELI' | 'SLU' | 'ESI'

Formato da empresa.

emailstring required

E-mail.

risk'LOW' | 'MEDIUM' | 'HIGH' required

Risco.

status'PENDING' | 'VALIDATION' | 'RISK_ANALYSIS' | 'APPROVED' | 'DISAPPROVED' | 'DISCREDITED' | 'DISCREDITED_PERMANENTLY' | 'BACKGROUND_CHECK' required

Status do estabelecimento.

categorystring required

Código da categoria comercial (MCC).

codestring required

Identificador alfanumérico único do estabelecimento

created_atstring date-time required

Data de criação.

updated_atstring date-time required

Data da última atualização.

deleted_atstring date-time required

Data de exclusão.

Example response

{
  "gateways": [
    {
      "bank_account": {
        "account_check_digit": "1",
        "account_number": "123456",
        "routing_check_digit": "9",
        "routing_number": "1234",
        "type": "CHECKING",
        "bank": {
          "name": "Banco X",
          "code": "022",
          "ispb": "02318222"
        }
      },
      "spb_account": {
        "account_check_digit": "1",
        "account_number": "123456",
        "routing_check_digit": "9",
        "routing_number": "1234",
        "type": "CHECKING",
        "bank": {
          "name": "Banco X",
          "code": "022",
          "ispb": "02318222"
        }
      },
      "metadata": {
        "code": "123",
        "email": "user@mail.com",
        "token": "456",
        "statement_descriptor": "X Pagamentos"
      }
    }
  ]
}