Skip to main content
POST
https://api.pronttus.com.br
/
v1
/
merchants
curl -X POST https://api.pronttus.com.br/v1/merchants \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -d '{
    "name": "João da Silva",
    "document": "12345678901",
    "document_type": "CPF",
    "email": "[email protected]",
    "phone": "11999999999"
  }'
{
  "statusCode": 201,
  "message": "Comerciante criado com sucesso",
  "data": {
    "merchant": {
      "id": "063ccba0-b7bd-40fb-a0b6-67e8f9035bbc",
      "name": "Marketplace Franquia 1",
      "document": "18996816000182",
      "document_type": "CNPJ",
      "email": "[email protected]",
      "phone": "11992323294",
      "status": "ACTIVE",
      "created_at": "2025-10-16T22:07:14.494Z",
      "updated_at": "2025-10-16T22:07:14.494Z"
    },
    "wallet_id": "aa2052c1-1087-421e-ac27-65380cbeb59e",
    "credentials": {
      "client_id": "c8abc652-92d9-4cb7-84a7-.....",
      "client_secret": "be50d57e1d85f32fb6170....."
    }
  }
}

Visão Geral

Este endpoint permite criar um novo merchant (subconta gráfica) para organizar recebimentos.
Para entender melhor o conceito de merchants e casos de uso, consulte a documentação conceitual.

Autenticação

Authorization
string
required
Token Bearer obtido no endpoint de autenticação Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...

Parâmetros do Body

name
string
required
Nome do merchant (ex: “João da Silva”)
document
string
required
CPF ou CNPJ do merchant (apenas números)
document_type
string
required
Tipo do documento: CPF ou CNPJ
email
string
required
E-mail do merchant
phone
string
required
Telefone do merchant com DDD (apenas números)
curl -X POST https://api.pronttus.com.br/v1/merchants \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -d '{
    "name": "João da Silva",
    "document": "12345678901",
    "document_type": "CPF",
    "email": "[email protected]",
    "phone": "11999999999"
  }'
{
  "statusCode": 201,
  "message": "Comerciante criado com sucesso",
  "data": {
    "merchant": {
      "id": "063ccba0-b7bd-40fb-a0b6-67e8f9035bbc",
      "name": "Marketplace Franquia 1",
      "document": "18996816000182",
      "document_type": "CNPJ",
      "email": "[email protected]",
      "phone": "11992323294",
      "status": "ACTIVE",
      "created_at": "2025-10-16T22:07:14.494Z",
      "updated_at": "2025-10-16T22:07:14.494Z"
    },
    "wallet_id": "aa2052c1-1087-421e-ac27-65380cbeb59e",
    "credentials": {
      "client_id": "c8abc652-92d9-4cb7-84a7-.....",
      "client_secret": "be50d57e1d85f32fb6170....."
    }
  }
}

Campos da Resposta

statusCode
integer
Código de status HTTP da resposta (201)
message
string
Mensagem de sucesso da operação
data
object
Dados do merchant criado
data.merchant
object
Informações do merchant criado
data.merchant.id
string
UUID único do merchant criado
data.merchant.name
string
Nome do merchant
data.merchant.document
string
CPF ou CNPJ do merchant
data.merchant.document_type
string
Tipo do documento: CPF ou CNPJ
data.merchant.email
string
E-mail do merchant
data.merchant.phone
string
Telefone do merchant
data.merchant.status
string
Status do merchant: ACTIVE, INACTIVE, SUSPENDED
data.merchant.created_at
string
Data de criação (ISO 8601)
data.merchant.updated_at
string
Data da última atualização (ISO 8601)
data.wallet_id
string
UUID da wallet principal criada para o merchant
data.credentials
object
Credenciais de API específicas do merchant
data.credentials.client_id
string
Client ID para autenticação do merchant
data.credentials.client_secret
string
Client Secret para autenticação do merchant
Mantenha as credenciais do merchant em segurança. Elas são necessárias para operações específicas deste merchant.

Informações Importantes

Wallet ID

O wallet_id retornado é o identificador da carteira principal do merchant. Este ID é usado para:
  • Configurar splits nas transações
  • Consultar saldo específico da wallet
  • Realizar transferências para/da wallet

Credenciais do Merchant

Cada merchant criado recebe suas próprias credenciais de API:
  • client_id: Identificador único do merchant
  • client_secret: Chave secreta para autenticação
As credenciais do merchant são diferentes das credenciais da conta principal e devem ser usadas para operações específicas deste merchant.

Status do Merchant

O merchant é criado com status ACTIVE por padrão, permitindo:
  • Receber splits de transações
  • Realizar operações normalmente
  • Acessar sua wallet