Atualizar um Merchant

put https://api.{dev}.geopagos.com.br/companies/{company_id}

Requisição de atualização das informações de uma company.Os parâmetros desta requisição são os mesmos da requisição de criação de company, mas nenhum parâmetro é obrigatório. Caso o usuário que requisita a alteração não tenha permissão de modificar os dados da company especificada, será retornado um erro HTTP 403.Caso a company com o company_id especificado não exista, se a requisição tiver informações suficientes para a criação de nova company (ou seja, caso os parâmetros obrigatórios do endpoint de criação de merchant estejam presentes), a company será criada com os parâmetros especificados. Caso contrário, será retornado um erro HTTP 400.

Path Params

company_id

string

required

Defaults to 5cfaa92b8e443f0007f6e628

Body Params

document_number

string

required

CPF/CNPJ do cadastro sendo criado

name

string

required

Defaults to John Doe 99999999911 MEI

Nome fantasia do cadastro sendo criado.

full_name

string

required

Defaults to John Doe 99999999911 MEI

Razão social do cadastro sendo criado. Em caso de pessoa física, esse campo deve ser preenchido com nome completo do usuário.

string

required

bank_account

object

required

contact

object

required

address

object

required

Endereço principal de operação

shipping_address

object

required

Endereço para entrega de terminais

estimated_monthly_tpv

int32

Defaults to 100000

Volume total transacionado (TPV) mensal estimado processo pelo cadastro (em centavos)

mcc

string

required

Defaults to 5211

Um Merchant Category Code (MCC) é um número de quatro dígitos, conforme especificado na ISO 18245. O MCC é usado para classificar o negócio pelo tipo fornecido de bens ou serviços, de forma semelhante aos códigos da CNAE no Brasil.

transfer_configurations

object

required

default_payment_provider

string

required

anticipation_type

string

required

Defaults to spot

Define o tipo de antecipação desse cadastro. Opções: 'automatic', 'spot' (pontual). Sendo 'spot' o valor default.

anticipation_days_interval

int32

required

Defaults to 1

Quantidade de dias após a data da criação da transação para a qual os recebíveis serão antecipados caso a antecipação automática esteja habilitada. Valores aceitos: de 1 até 30

metadata

json

Defaults to {"exemplo":"valor 1", "internal_id": "123456789"}

Um objeto chave/valor para se guardar qualquer tipo de informação atrelada ao merchant. Por exemplo um ID de um sistema externo.

email_configurations

object

main_capture_method

string

Defaults to pos

Responses

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
28
1
curl --request PUT \
2
     --url https://api.dev.geopagos.com.br/companies/5cfaa92b8e443f0007f6e628 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "name": "John Doe 99999999911 MEI",
8
  "full_name": "John Doe 99999999911 MEI",
9
  "estimated_monthly_tpv": 100000,
10
  "mcc": "5211",
11
  "transfer_configurations": {
12
    "automatic_transfer_enabled": true,
13
    "transfer_frequency": "daily",
14
    "transfer_date": 1
15
  },
16
  "anticipation_type": "spot",
17
  "anticipation_days_interval": 1,
18
  "metadata": {
19
    "exemplo": "valor 1",
20
    "internal_id": "123456789"
21
  },
22
  "email_configurations": {
23
    "custom_domain_enabled": false,
24
    "send_activation_email": false
25
  },
26
  "main_capture_method": "pos"
27
}
28
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

400400