Sign in

v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Estabelecimentos

Ativar gateway

post/v1/marketplace/establishments/{id}/gateways

Path parameters

idstring 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

gateway_id2 | 4 | 6 required

ID da plataforma a ser ativada: 2 - PAGSEGURO, 4 - PAYTIME, 6 - BANKING

activeboolean required

True ativa a plataforma; false desativa a plataforma.

form_receipt'BANKACCOUNT' | 'PAYTIME' | 'PAGBANK' required

Forma de recebimento dos valores.

statement_descriptorstring

Nome a ser exibido na fatura. Obrigatório na ativação da plataforma Sub Paytime.

fees_banking_idnumber

Pacote de tarifas bancárias a ser associado. Obrigatório para ativação do Banking.

Example request

{
  "reference_id": "ABC-123",
  "bank_account": {
    "type": "CHECKING"
  },
  "plans": [
    {
      "id": 5,
      "active": true
    }
  ]
}

Response

idnumber required

ID da configuração do gateway.

establishment_idnumber required

ID do estabelecimento.

gateway_keystring nullable required

Chave do gateway (caso exista).

status'PENDING' | 'WAITING' | 'ANALYZE' | 'BLOCKED' | 'CANCELED' | 'DISAPPROVED' | 'APPROVED' required

Status da configuração do gateway.

activeboolean required

Indica se está ativo.

form_receipt'BANKACCOUNT' | 'PAYTIME' | 'PAGBANK' | 'ZOOPBANK' nullable required

Forma de recebimento dos valores.

created_atstring date-time required

Data de criação.

updated_atstring date-time nullable required

Data da última atualização.

Example response

{
  "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"
  }
}