Skip to content

Instantly share code, notes, and snippets.

@dmsysop

dmsysop/Zoop API

Created January 25, 2020 01:32
Show Gist options
  • Save dmsysop/fd543a7d2ab4e943bcbf78be9325b211 to your computer and use it in GitHub Desktop.
Save dmsysop/fd543a7d2ab4e943bcbf78be9325b211 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Zoop API
swagger: '2.0'
host: api.zoop.ws
info:
title: Zoop Payments API
version: "1.0"
description: |
Essa documentação descreve os recursos que compõem a API Zoop, em
conformidade com os princípios de design REST.
Todas as respostas da API estão no formato de dados JSON.
Com a API Zoop, você pode aceitar instantaneamente e de forma segura os
pagamentos com cartão-presente e cartão não presente diretamente de sua
aplicação em qualquer plataforma ou dispositivo.
Nós criamos essa API para permitir que você e outros desenvolvedores criem
maneiras inovadoras de movimentar dinheiro. Com apenas algumas linhas de
código, você estará pronto para transacionar.
Nossos SDKs facilitam a sua integração e a nossa API RESTful facilita o seu
desenvolvimento.
Junte-se a nossa comunidade para ser notificado sobre as atualizações da
API, acesse https://docs.pagzoop.com.
termsOfService: 'https://pagzoop.com/terms/'
contact:
email: [email protected]
securityDefinitions:
basicAuth:
type: basic
security:
- basicAuth: []
tags:
- name: 'Vendedor'
description: 'Pessoas ou empresas que vendem dentro do seu marketplace.'
- name: 'Comprador'
description: 'Pessoas ou empresas que compram dentro do seu marketplace'
- name: 'Transação'
description: Operações de pagamento
- name: 'Token'
description: Token de cartões de crédito
- name: 'Saldo de Conta'
description: Saldo de conta zoop
- name: 'Webhook'
description: Notifiações sobre eventos
- name: 'Evento'
description: Notifiações e eventos de alteração de estado
- name: 'Transação'
description: Operações de pagamento com dados de cartão de crédito
- name: 'Transação Cartão Presente (CHIP&PIN)'
description: Operações de pagamento com maquininha chip e senha
- name: 'Boleto'
description: Operações de pagamento via boleto bancário registrado
- name: 'Cartão'
description: Cartões de crédito/débito utilizados nos pagamentos
- name: 'Regra de Divisão'
description: Regras de divisão (split) de um pagamento
- name: 'Recibo'
description: Recibos de pagamentos realizados com sucesso
- name: 'Transferência'
description: Depósitos para conta bancária e conta de cartão
- name: 'Conta Bancária'
description: Conta bancária
- name: 'Recebível'
description: Parcelas de recebimento de uma transação
- name: 'Política de Recebimento'
description: Política de Recebimento de vendas
- name: 'Plano de Vendas'
description: 'Plano de taxas de venda'
- name: 'Usuário'
description: Usuários de acesso a API
- name: 'API Key'
description: Chaves de acesso a API
- name: 'Marketplace'
description: Criação de marketplaces
- name: 'Planos'
description: 'Um plano define como assinaturas serão vendidas, renovadas e faturadas'
- name: 'Assinaturas'
description: 'Assinatura é a relação entre um plano e um cliente'
- name: 'Faturas'
description: 'A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente'
- name: 'Descontos'
description: 'Representa um desconto aplicado a uma assinatura ou fatura'
schemes:
- https
paths:
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/documents':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: seller_id
in: path
description: ID do vendedor
required: true
type: string
post:
tags:
- 'Vendedor'
summary: Criar documento de cadastro de vendedor
description: ''
operationId: addDocument
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: file
type: file
in: formData
required: true
description: Documento que será cadastrado
- name: category
in: formData
type: string
required: true
description: Categoria do documento cadastrado
- name: metadata
in: formData
type: string
description: Metadados associados ao documento
- name: description
in: formData
type: string
description: Descrição do documento
responses:
'201':
description: Documento criado com sucesso
schema:
$ref: '#/definitions/Document'
'404':
description: 'Marketplace/Vendedor/Documento não encontrado'
get:
tags:
- 'Vendedor'
summary: Listar documentos de um vendedor
description: ''
operationId: findSellerDocument
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
responses:
'200':
description: Documentos recuperados com sucesso
schema:
$ref: '#/definitions/Documents'
'404':
description: 'Marketplace/Vendedor não encontrado'
'/v1/marketplaces/{marketplace_id}/sellers/documents/{id}':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: id
in: path
description: ID do documento
required: true
type: string
put:
tags:
- 'Vendedor'
summary: Atualiza os dados de um documento de um vendedor
description: ''
operationId: updateDocument
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Document object
required: true
schema:
$ref: '#/definitions/Document'
responses:
'200':
description: Documento alterado com sucesso
schema:
$ref: '#/definitions/Document'
'404':
description: 'Marketplace/Documento não encontrado'
'/v1/merchant_category_codes':
get:
tags:
- 'Vendedor'
summary: Listar MCCs (Merchant Category Codes)
description: ''
operationId: ''
produces:
- application/json
responses:
'200':
description: Operação realizada com sucesso
schema:
example: {
resource: "list",
uri: "/v1/merchant_category_codes",
items: [
{
id: "1",
code: "5300",
category: "Alimentação",
description: "Atacado",
resource: "merchant_category_code"
}
],
has_more: true,
limit: 100,
total_pages: 2,
page: 1,
offset: 0,
total: "103"
}
'/v1/marketplaces/{marketplace_id}/sellers/individuals':
post:
tags:
- 'Vendedor'
summary: Criar novo vendedor do tipo indivíduo
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- in: body
name: body
description: Individual object
required: true
schema:
$ref: '#/definitions/Individual'
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Vendedor cadastrado com sucesso
schema:
$ref: '#/definitions/Individual'
'404':
description: 'Marketplace não encontrado'
'400':
description: 'Missing required param'
'/v1/marketplaces/{marketplace_id}/sellers/individuals/{id}':
put:
tags:
- 'Vendedor'
summary: Alterar um vendedor do tipo indivíduo
consumes:
- application/json
produces:
- application/json
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: id
in: path
description: ID do documento
required: true
type: string
- in: body
name: body
description: Individual object
required: true
schema:
$ref: '#/definitions/Individual'
responses:
'200':
description: Vendedor alterado com sucesso
schema:
$ref: '#/definitions/Individual'
'404':
description: 'Marketplace não encontrado'
'400':
description: 'Missing required param'
'/v1/marketplaces/{marketplace_id}/sellers/businesses':
post:
tags:
- 'Vendedor'
summary: Criar novo vendedor do tipo empresa
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- in: body
name: body
description: Individual object
required: true
schema:
$ref: '#/definitions/Business'
consumes:
- application/json
produces:
- application/json
responses:
'201':
description: Vendedor cadastrado com sucesso
schema:
$ref: '#/definitions/Business'
'404':
description: 'Marketplace não encontrado'
'400':
description: 'Missing required param'
'/v1/marketplaces/{marketplace_id}/sellers/businesses/{id}':
put:
tags:
- 'Vendedor'
summary: Alterar um vendedor do tipo empresa
consumes:
- application/json
produces:
- application/json
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: id
in: path
description: ID do documento
required: true
type: string
- in: body
name: body
description: Individual object
required: true
schema:
$ref: '#/definitions/Business'
responses:
'200':
description: Vendedor alterado com sucesso
schema:
$ref: '#/definitions/Business'
'404':
description: 'Marketplace/Vendedor não encontrado'
'400':
description: 'Missing required param'
'/v1/marketplaces/{marketplace_id}/sellers/{id}':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: id
in: path
description: ID do vendedor do tipo individuo ou empresa
required: true
type: string
get:
tags:
- 'Vendedor'
summary: Recupera detalhes de vendedor pelo id
produces:
- application/json
responses:
'200':
description: Vendedor recuperado com sucesso
schema:
$ref: '#/definitions/Individual'
'404':
description: 'Marketplace/Vendedor não encontrado'
delete:
tags:
- 'Vendedor'
summary: Deleta um de vendedor pelo id
produces:
- application/json
responses:
'200':
description: Vendedor deletado com sucesso
schema:
example:
{
'id': "17d9e827664b47509f12a082b6047e7a",
'resource': 'seller',
'type': 'individual',
'deleted': true
}
'404':
description: 'Marketplace/Vendedor não encontrado'
'/v1/marketplaces/{marketplace_id}/sellers':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
get:
tags:
- 'Vendedor'
summary: Listando vendedores
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
responses:
'200':
description: Vendedor recuperado com sucesso
schema:
$ref: '#/definitions/Individuals'
'404':
description: 'Marketplace/Vendedor não encontrado'
'/v1/marketplaces/{marketplace_id}/sellers/search':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
get:
tags:
- 'Vendedor'
summary: Buscando de vendedor por CPF/CNPJ
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: search
schema:
type: object
properties:
taxpayer_id:
type: string
description: CPF do vendedor
ein:
type: string
description: CNPJ do vendedor
responses:
'200':
description: Vendedor encontrado com sucesso
schema:
$ref: '#/definitions/Individual'
'404':
description: 'Vendedor não encontrado'
'400':
description: 'Missing required parameter'
'/v1/marketplaces/{marketplace_id}/transactions':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
get:
summary: Listar transaçoes do marketplace
tags:
- Transação
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
responses:
'200':
description: Transações recuperadas com sucesso
schema:
$ref: '#/definitions/Transactions'
'404':
description: 'Marketplace não encontrado'
post:
summary: Criar transação Cartão Não Presente
tags:
- Transação
consumes:
- application/json
produces:
- application/json
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- in: body
name: body
description: Transacao
schema:
$ref: '#/definitions/TransactionCNPRequest'
responses:
'200':
description: Transação criada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'404':
description: 'Transação não encontrada'
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/transactions':
parameters:
- name: marketplace_id
in: path
description: ID do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
summary: Listar transaçoes por vendedor
tags:
- Transação
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
responses:
'200':
description: Transações recuperadas com sucesso
schema:
$ref: '#/definitions/Transactions'
'404':
description: 'Marketplace não encontrado'
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
get:
summary: Recuperar detalhes de transação pelo identificador
tags:
- Transação
produces:
- application/json
responses:
'200':
description: Transação recuperada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'404':
description: 'Transação não encontrada'
put:
summary: Alterar detalhes de transação pelo identificador
tags:
- Transação
consumes:
- application/json
produces:
- application/json
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
- in: body
name: body
description: Transacao
required: true
schema:
$ref: '#/definitions/TransactionUpdateRequest'
responses:
'200':
description: Transação alterada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'404':
description: 'Transação não encontrada'
'/v1/marketplaces/{marketplace_id}/buyers':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Comprador'
summary: 'Criar comprador'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Comprador criado com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace não encontrado
get:
tags:
- 'Comprador'
summary: 'Listar comprador por marketplace'
description: ''
produces:
- application/json
responses:
'200':
description: Comprador encontrado
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/buyers/{buyer_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: buyer_id
in: path
description: identificador do buyer
required: true
type: string
put:
tags:
- 'Comprador'
summary: 'Alterar detalhes de comprador'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Comprador alterado com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Buyer não encontrado
get:
tags:
- 'Comprador'
summary: 'Recuperar detalhes de comprador'
description: ''
produces:
- application/json
responses:
'200':
description: Comprador alterado com sucesso
'404':
description: Marketplace/Buyer não encontrado
delete:
tags:
- 'Comprador'
summary: 'Remover comprador pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Comprador removido com sucesso
'404':
description: Marketplace/Buyer não encontrado
'/v1/marketplaces/{marketplace_id}/buyers/search':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
get:
tags:
- 'Comprador'
summary: 'Buscar comprador por CPF/CNPJ'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Comprador encontrado
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/balances':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Recuperar saldo de conta por seller'
description: 'Recupera o saldo corrente e saldo total de conta'
produces:
- application/json
responses:
'200':
description: Saldo recuperado com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/balances/all':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Lista contas por seller'
description: ''
produces:
- application/json
responses:
'200':
description: Saldo recuperado com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/buyers/{buyer_id}/balances':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: buyer_id
in: path
description: identificador do comprador
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Lista contas por buyer'
description: ''
produces:
- application/json
responses:
'200':
description: Saldo recuperado com sucesso
'404':
description: Marketplace/Buyer não encontrado
'/v1/marketplaces/{marketplace_id}/balances/{balance_id}/history':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: balance_id
in: path
description: identificador da conta
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Listar histórico de lançamentos pelo identificador da conta'
description: ''
produces:
- application/json
responses:
'200':
description: Histórico recuperado com sucesso
'404':
description: Marketplace/Saldo não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/balances/history':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Listar histórico de lançamentos de conta por seller'
description: 'Listagem de histórico da conta principal do seller'
produces:
- application/json
responses:
'200':
description: Histórico recuperado com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/buyers/{buyer_id}/balances/history':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: buyer_id
in: path
description: identificador do comprador
required: true
type: string
get:
tags:
- 'Saldo de Conta'
summary: 'Listar histórico de lançamentos de conta por buyer'
description: 'Listagem de histórico da conta principal do buyer'
produces:
- application/json
responses:
'200':
description: Histórico recuperado com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/cards/tokens':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Token'
summary: 'Criar novo token de cartão'
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: token data
required: true
schema:
$ref: '#/definitions/TokenCardRequest'
responses:
'200':
description: Token de cartão criado com sucesso
'400':
description: Requisição/Parâmetros invalidos
'404':
description: Marketplace/ não encontrado
'/v1/marketplaces/{marketplace_id}/bank_accounts/tokens':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Token'
summary: 'Criar novo token de conta bancária'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Token de cartão criado com sucesso
'400':
description: Requisição/Parâmetros invalidos
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/tokens/{token_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: token_id
in: path
description: identificador do token
required: true
type: string
get:
tags:
- 'Token'
summary: 'Recuperar detalhes de token de cartão/conta bancária'
description: ''
produces:
- application/json
responses:
'200':
description: Token recuperado com sucesso
'404':
description: Marketplace/Token não encontrado
'/v1/marketplaces/{marketplace_id}/webhooks':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Webhook'
summary: 'Cria webhook por marketplace'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Webhook criado com sucesso
'400':
description: Requisição inválida
'404':
description: Marketplace não encontrado
get:
tags:
- 'Webhook'
summary: 'Listar webhooks por marketplace'
description: ''
produces:
- application/json
responses:
'200':
description: Webhook listado com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/webhooks/{webhook_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: webhook_id
in: path
description: identificador do webhook
required: true
type: string
get:
tags:
- 'Webhook'
summary: 'Recuperar detalhes de webhook'
description: ''
produces:
- application/json
responses:
'200':
description: Webhook recuperado com sucesso
'404':
description: Marketplace/Webhook não encontrado
delete:
tags:
- 'Webhook'
summary: 'Remover webhook'
description: ''
produces:
- application/json
responses:
'200':
description: Webhook removido com sucesso
'404':
description: Marketplace/Webhook não encontrado
'/v1/marketplaces/{marketplace_id}/events/{event_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: event_id
in: path
description: identificador do evento
required: true
type: string
get:
tags:
- 'Evento'
summary: 'Recuperar detalhes de evento pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Evento recuperado com sucesso
'404':
description: Marketplace/Evento não encontrado
'/v1/marketplaces/{marketplace_id}/events':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
get:
tags:
- 'Evento'
summary: 'Listar eventos por marketplace'
description: ''
produces:
- application/json
responses:
'200':
description: Evento listado com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/void':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
post:
tags:
- Transação
summary: 'Estornar transação cartão não presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação estornada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: Requisição/Parametros inválidos
'404':
description: Marketplace/Transação não encontrado
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/capture':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
post:
tags:
- Transação
summary: 'Capturar transação cartão não presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação capturada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: Requisição/Parametros inválidos
'404':
description: Marketplace/Transação não encontrado
'/v1/marketplaces/{marketplace_id}/cards/{card_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: card_id
in: path
description: identificador do cartão
required: true
type: string
get:
tags:
- 'Cartão'
summary: 'Recuperar detalhes de cartão pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Cartão recuperado com sucesso
'404':
description: Marketplace/Cartão não encontrado
'/v1/marketplaces/{marketplace_id}/cards':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Cartão'
summary: 'Associar cartão com comprador'
description: 'Associar token de cartão com comprador'
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Cartão associado com sucesso
'400':
description: Requisição/Parâmetros invalidos
'404':
description: Marketplace/ não encontrado
get:
tags:
- 'Cartão'
summary: 'Recuperar detalhes de cartão pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Cartão recuperado com sucesso
'404':
description: Marketplace/Cartão não encontrado
delete:
tags:
- 'Cartão'
summary: 'Remover cartão pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Cartão removido com sucesso
'404':
description: Marketplace/Cartão não encontrado
put:
tags:
- 'Cartão'
summary: 'Atualizar detalhes de cartão pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Cartão atualizado com sucesso
'404':
description: Marketplace/Cartão não encontrado
'/v1/card-present/terminals':
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Criar novo terminal'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Terminal cadastrado com sucesso
'400':
description: 'Missing required param'
'/v1/card-present/terminals/{terminal_id}':
parameters:
- name: terminal_id
in: path
description: identificador do terminal
required: true
type: string
put:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Alterar detalhes de terminal pelo identificador'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Terminal alterado com sucesso
'400':
description: 'Missing required param'
'404':
description: Terminal não encontrado
get:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Recuperar detalhes de terminal pelo identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Terminal recuperado com sucesso
'404':
description: Terminal não encontrado
delete:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Remover terminal pelo identificador'
description: ''
responses:
'200':
description: Terminal removido com sucesso
'404':
description: Terminal não encontrado
'/v1/card-present/terminals/search':
get:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Buscar terminal pelo serial number'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Busca realizada com sucesso
'400':
description: 'Missing required param'
'/v1/card-present/terminals/{terminal_id}/logon':
parameters:
- name: terminal_id
in: path
description: terminal_id
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Recuperar parâmetros de inicialização por terminal'
description: ''
produces:
- application/json
responses:
'200':
description: Terminal recuperado com sucesso
'404':
description: Terminal não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/sellers/{seller_id}/transactions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Criar transação cartão presente'
deprecated: true
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação criada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: 'Missing required param'
'404':
description: Marketplace/Seller não encontrado
'/v1.1/card-present/marketplaces/{marketplace_id}/sellers/{seller_id}/transactions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Criar transação cartão presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação criada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: 'Missing required param'
'404':
description: Marketplace/Seller não encontrado
'/v1.1/card-present/marketplaces/{marketplace_id}/transactions/{transaction_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
put:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Confirmar transação cartão presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação confirmada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: 'Missing required param'
'404':
description: Marketplace/Seller não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/sellers/{seller_id}/preauthorizations':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Criar transação de pre-autorização cartão presente'
description: ''
deprecated: true
responses:
'200':
description: Transação de pre-autorização criada com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Seller não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/preauthorizations/{transaction_id}/capture':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador do transação de pre-autorização
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Capturar transação de pre-autorização cartão presente'
description: ''
deprecated: true
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação capturada com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Transação não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/transactions/{transaction_id}/void':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador do transação
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Estornar transação cartão presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação estornada com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: 'Missing required param'
'404':
description: Marketplace/Transação não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/preauthorizations/{transaction_id}/void':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador do transação de pre-autorização
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Estornar transação de pre-autorização cartão presente'
description: ''
deprecated: true
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação de pre-autorização estornada com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Transação não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/transactions/{transaction_id}/reversals':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador do transação
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Desfazer transação de cartão presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação desfeita com sucesso
schema:
$ref: '#/definitions/TransactionResponse'
'400':
description: 'Missing required param'
'404':
description: Marketplace/Transação não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/preauthorizations/{transaction_id}/reversals':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador do transação de pre-autorização
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Desfazer transação de pre-autorização cartão presente'
description: ''
deprecated: true
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação de pre-autorização desfeita com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Transação não encontrado
'/v2/card-present/terminals/{terminal_id}/logon':
parameters:
- name: terminal_id
in: path
description: identificador do terminal
required: true
type: string
post:
tags:
- "Transação Cartão Presente (CHIP&PIN)"
summary: 'Recuperar parâmetros de inicialização por terminal'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Logon recuperado com sucesso
'404':
description: Terminal não encontrado
'/v1/card-present/marketplaces/{marketplace_id}/sellers/{seller_id}/advices':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
post:
tags:
- 'Transação Cartão Presente (CHIP&PIN)'
summary: 'Processar aviso de falha transação cartão presente'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Transação de aviso realizada com sucesso
'400':
description: 'Missing required param'
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/receipts/{receipt_id}/emails':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receipt_id
in: path
description: identificador do recibo
required: true
type: string
post:
tags:
- 'Recibo'
summary: 'Enviar recibo por email'
description: ''
consumes:
- application/json
responses:
'200':
description: Recibo enviado com sucesso
'404':
description: Marketplace/Recibo não encontrada
'/v1/marketplaces/{marketplace_id}/receipts/{receipt_id}/texts':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receipt_id
in: path
description: identificador do recibo
required: true
type: string
post:
tags:
- 'Recibo'
summary: 'Enviar recibo por SMS'
description: ''
consumes:
- application/json
responses:
'200':
description: Recibo enviado com sucesso
'404':
description: Marketplace/Recibo não encontrada
'/v1/marketplaces/{marketplace_id}/receipts/{receipt_id}/send':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receipt_id
in: path
description: identificador do recibo
required: true
type: string
post:
tags:
- 'Recibo'
summary: 'Enviar recibo por sms.email'
description: ''
consumes:
- application/json
responses:
'200':
description: Recibo enviado com sucesso
'404':
description: Marketplace/Recibo não encontrada
'/v1/marketplaces/{marketplace_id}/receipts/{receipt_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receipt_id
in: path
description: identificador do recibo
required: true
type: string
get:
tags:
- 'Recibo'
summary: 'Recuperar detalhes do recibo'
description: ''
produces:
- application/json
responses:
'200':
description: Recibo recuperado com sucesso
'404':
description: Marketplace/Recibo não encontrada
put:
tags:
- 'Recibo'
summary: 'Alterar detalhes do recibo'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Recibo alteardo com sucesso
'404':
description: Marketplace/Recibo não encontrada
'/v1/receipts/{marketplace_id}/{receipt_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receipt_id
in: path
description: identificador do recibo
required: true
type: string
get:
tags:
- 'Recibo'
summary: 'Renderizar template de recibo HTML'
description: ''
security: []
produces:
- text/html
responses:
'200':
description: Recibo renderizado com sucesso
'404':
description: Marketplace/Recibo não encontrada
'/v1/marketplaces/{marketplace_id}/boletos/{boleto_id}/emails':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: boleto_id
in: path
description: identificador do boleto
required: true
type: string
post:
tags:
- 'Boleto'
summary: 'Enviar cobrança de boleto por email'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Boleto enviado por email
'404':
description: Marketplace/Boleto não encontrado
'/v1/marketplaces/{marketplace_id}/boletos/{boleto_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: boleto_id
in: path
description: identificador do boleto
required: true
type: string
get:
tags:
- 'Boleto'
summary: 'Recuperar detalhes de boleto'
description: ''
produces:
- application/json
responses:
'200':
description: Boleto recuperado com sucesso
'404':
description: Marketplace/Boleto não encontrado
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/split_rules':
parameters:
- name: marketplace_id
in: path
description: marketplace_id
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
get:
tags:
- "Regra de Divisão"
summary: 'Recuperar detalhes de regra de divisão por transação'
description: ''
produces:
- application/json
responses:
'200':
description: Split recuperado com sucesso
'404':
description: Marketplace/Transação não encontrado
post:
tags:
- "Regra de Divisão"
summary: 'Criar regra de divisão por transação'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Split criado com sucesso
'404':
description: Marketplace/Transação não encontrado
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/split_rules/{id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
- name: id
in: path
description: identificador do split
required: true
type: string
get:
tags:
- "Regra de Divisão"
summary: 'Recupera detalhes de regra de divisão por transação'
description: ''
produces:
- application/json
responses:
'200':
description: Split recuperado com sucesso
'404':
description: Marketplace/Transação não encontrado
put:
tags:
- "Regra de Divisão"
summary: 'Alterar regra de divisão por transação'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Split alterado com sucesso
'404':
description: Marketplace/Transação não encontrado
delete:
tags:
- "Regra de Divisão"
summary: 'Remover regra de divisão por transação'
description: ''
produces:
- application/json
responses:
'200':
description: Split criado com sucesso
'404':
description: Marketplace/Transação não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/transfers':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
tags:
- 'Transferência'
summary: 'Listar transferências por seller'
description: ''
produces:
- application/json
responses:
'200':
description: Transferências encontradas
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/bank_accounts/{bank_account_id}/transfers':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: bank_account_id
in: path
description: identificador da conta bancária
required: true
type: string
post:
tags:
- 'Transferência'
summary: 'Criar transferência para bancária'
parameters:
- in: body
name: body
description: Document object
required: true
schema:
$ref: '#/definitions/Transfer'
description: ''
produces:
- application/json
responses:
'200':
description: Transferências recuperadas com sucesso
'404':
description: Marketplace/Conta bancária não encontrado
'/v1/marketplaces/{marketplace_id}/transfers':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
get:
tags:
- 'Transferência'
summary: 'Listar transferência por marketplace'
description: ''
produces:
- application/json
responses:
'200':
description: Transferências recuperadas com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/transfers/{transfer_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transfer_id
in: path
description: identificador do transferênci
required: true
type: string
get:
tags:
- 'Transferência'
summary: 'Recuperar detalhes de transferência'
description: ''
produces:
- application/json
responses:
'200':
description: Transferência recuperada com sucesso
'404':
description: Marketplace/Transferência não encontrada
'/v1/marketplaces/{marketplace_id}/transfers/{transfer_id}/transactions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transfer_id
in: path
description: identificador do transferência
required: true
type: string
get:
tags:
- 'Transferência'
summary: 'Listar transações associadas a transferência'
description: ''
deprecated: true
produces:
- application/json
responses:
'200':
description: Transferência recuperada com sucesso
'404':
description: Marketplace/Transferência não encontrada
'/v1/marketplaces/{marketplace_id}/bank_accounts/{bank_account_id}':
parameters:
- name: marketplace_id
in: path
description: identificador de marketplace_id
required: true
type: string
- name: bank_account_id
in: path
description: identificador de conta bancária
required: true
type: string
get:
tags:
- 'Conta Bancária'
summary: 'Recuperar detalhes de conta bancária por identificador'
description: ''
produces:
- application/json
responses:
'200':
description: Conta bancária recuperada com sucesso
'404':
description: Marketplace/Conta Bancária não encontrada
put:
tags:
- 'Conta Bancária'
summary: 'Alterar detalhes de conta bancária'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Conta bancária alterada com sucesso
'400':
description: Requisição/Parâmetros inválidos
'404':
description: Marketplace/Conta Bancária não encontrada
delete:
tags:
- 'Conta Bancária'
summary: 'Alterar detalhes de conta bancária'
description: ''
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Conta bancária recuperada com sucesso
'400':
description: Requisição/Parâmetros inválidos
'404':
description: Marketplace/Conta Bancária não encontrada
'/v1/marketplaces/{marketplace_id}/bank_accounts':
parameters:
- name: marketplace_id
in: path
description: identificador de marketplace_id
required: true
type: string
get:
tags:
- 'Conta Bancária'
summary: 'Listar contas bancárias por marketplace'
description: ''
produces:
- application/json
responses:
'200':
description: Conta bancária recuperada com sucesso
'404':
description: Marketplace não encontrado
post:
tags:
- 'Conta Bancária'
summary: 'Associar conta bancaria com customer'
description: 'Associar token de cartão com comprador'
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Bank Account object
required: true
schema:
$ref: '#/definitions/BankAccount'
responses:
'200':
description: Conta bancária associado com sucesso
'400':
description: Requisição/Parâmetros invalidos
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/bank_accounts':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador do seller
required: true
type: string
get:
tags:
- 'Conta Bancária'
summary: 'Listar contas bancárias por seller'
description: ''
produces:
- application/json
responses:
'200':
description: Conta bancária recuperada com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/receivables/{receivable_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: receivable_id
in: path
description: identificador do recebível
required: true
type: string
get:
tags:
- "Recebível"
summary: 'Recuperar detalhes de recebível'
description: ''
produces:
- application/json
responses:
'200':
description: Recebível recuperado com sucesso
'404':
description: Marketplace/Recebível não encontrado
'/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/receivables':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: transaction_id
in: path
description: identificador da transação
required: true
type: string
get:
tags:
- "Recebível"
summary: 'Listar recebíveis por transação'
description: 'Listar todas as parcelas de recebimento por transação'
produces:
- application/json
responses:
'200':
description: Recebível listado com sucesso
'404':
description: Marketplace/Transação não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/receivables':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador da seller
required: true
type: string
get:
tags:
- "Recebível"
summary: 'Listar recebíveis por seller'
description: 'Listar todas as parcelas de recebimento por seller'
produces:
- application/json
responses:
'200':
description: Recebível listado com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/receiving_policy':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador da seller
required: true
type: string
get:
tags:
- "Política de Recebimento"
summary: 'Recuperar política de recebimento por seller'
description: ''
produces:
- application/json
responses:
'200':
description: Politica recuperada com sucesso
'404':
description: Marketplace/Seller não encontrado
post:
tags:
- "Política de Recebimento"
summary: 'Alterar política de recebimento por seller'
description: ''
parameters:
- in: body
name: body
description: Receiving Policy object
required: true
schema:
$ref: '#/definitions/ReceivingPolicy'
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Politica alterada com sucesso
'404':
description: Marketplace/Seller não encontrado
'/v2/marketplaces/{marketplace_id}/transfers/{owner}/to/{receiver}':
parameters:
- name: marketplace_id
in: path
description: identificador do markteplace
required: true
type: string
- name: owner
in: path
description: identificador do customer pagador
required: true
type: string
- name: receiver
in: path
description: identificador do customer recebedor
required: true
type: string
post:
tags:
- "Transferência"
summary: 'Criar transferência P2P'
description: ''
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: TransferP2P object
required: true
schema:
$ref: '#/definitions/TransferP2P'
responses:
'200':
description: Transferência criada com sucesso
'404':
description: Marketplace/Customer não encontrado
'/v1/marketplaces/{marketplace_id}/plans':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Plano de Vendas'
summary: 'Criar plano de vendas'
deprecated: true
description: 'Planos com taxa e políticas para credito de recebíveis'
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Plano de venda criado com sucesso
'404':
description: Marketplace não encontrado
get:
tags:
- 'Plano de Vendas'
description: ''
deprecated: true
summary: 'Listar plano de vendas por marketplace'
produces:
- application/json
responses:
'200':
description: Plano de venda listado com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/plans/{plan_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: plan_id
in: path
description: identificador do plano
required: true
type: string
get:
tags:
- 'Plano de Vendas'
summary: 'Recuperar detalhes de plano de venda'
deprecated: true
description: ''
produces:
- application/json
responses:
'200':
description: Plano de venda criado com sucesso
'404':
description: Marketplace/Plano não encontrado
delete:
tags:
- 'Plano de Vendas'
summary: 'Remover plano de venda'
description: ''
deprecated: true
produces:
- application/json
responses:
'200':
description: Plano de venda removido com sucesso
'404':
description: Marketplace/Plano não encontrado
'/v1/marketplaces/{marketplace_id}/subscriptions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Plano de Vendas'
summary: 'Criar assinatura de plano de venda'
description: ''
deprecated: true
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda removido com sucesso
'404':
description: Marketplace não encontrado
get:
tags:
- 'Plano de Vendas'
summary: 'Listar assinaturas de plano de venda'
description: ''
deprecated: true
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda listado com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/subscriptions/{subscription_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: subscription_id
in: path
description: identificador da assinatura de plano de venda
required: true
type: string
get:
tags:
- 'Plano de Vendas'
deprecated: true
summary: 'Recuperar detalhes de assinatura de plano de venda'
description: ''
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda recuperado com sucesso
'404':
description: Marketplace não encontrado
delete:
tags:
- 'Plano de Vendas'
summary: 'Remover assinatura de plano de venda'
deprecated: true
description: ''
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda removido com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/subscriptions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: seller_id
in: path
description: identificador da seller
required: true
type: string
get:
tags:
- 'Plano de Vendas'
summary: 'Recuperar assinatura de plano de venda por seller'
description: ''
deprecated: true
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda recuperado com sucesso
'404':
description: Marketplace não encontrado
'/v1/marketplaces/{marketplace_id}/buyers/{buyer_id}/subscriptions':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: buyer_id
in: path
description: identificador do buyer
required: true
type: string
get:
tags:
- 'Plano de Vendas'
summary: 'Recuperar assinatura de plano de venda por comprador'
description: ''
deprecated: true
produces:
- application/json
responses:
'200':
description: Assinatura de plano de venda recuperado com sucesso
'404':
description: Marketplace não encontrado
'/v1/users/{user_id}/permissions':
parameters:
- $ref: '#/parameters/userIdParam'
get:
tags:
- Usuário
summary: Permissão do usuário
operationId: permissions_get
description: |
Busca todas as permissões que usuário possui pelo user_id
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
responses:
200:
description: Permissions the user_id
schema:
$ref: '#/definitions/PermissionResponse'
404:
description: user_id not found
post:
tags:
- Usuário
summary: Criar permissão para usuário
operationId: permissions_post
description: |
Cria uma nova permissão para o usuário, podendo vincular à marketplace, seller ou grupo
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: permission
description: criar uma nova permissão para usuário
schema:
$ref: '#/definitions/PermissionRequest'
responses:
201:
description: New permission created
schema:
$ref: '#/definitions/UserPermissioResponse'
400:
description: invalid input, object invalid
409:
description: an item already exists
'/v1/users/{user_id}/permissions/{permission_id}':
parameters:
- $ref: '#/parameters/userIdParam'
- $ref: '#/parameters/permissionIdParam'
get:
tags:
- Usuário
summary: Permissão do usuário por permission_id
operationId: permissions_id_get
description: |
Permissões que usuário possui pelo permission_id
produces:
- application/json
responses:
200:
description: Permission the permission_id
schema:
$ref: '#/definitions/UserPermissioResponse'
404:
description: permission_id or user_id not found
delete:
tags:
- Usuário
summary: deleta uma permissão
operationId: permissions_id_delete
description: Remove uma permissões do usuário pelo permission_id
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: '#/parameters/userIdParam'
- $ref: '#/parameters/permissionIdParam'
responses:
200:
description: Permission deleted
404:
description: permission_id not found
'/v1/marketplaces/{marketplace_id}/users':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'Usuário'
summary: 'Criar novo usuário de API por marketplace'
description: ''
operationId: users_marketplace_post
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: User request object
required: true
schema:
$ref: '#/definitions/UserRequest'
responses:
'200':
description: Usuário criado com sucesso
schema:
$ref: '#/definitions/UserResponse'
'/v1/users':
post:
tags:
- 'Usuário'
summary: 'Criar novo usuário de API'
description: ''
security: []
operationId: users_post
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: User request object
required: true
schema:
$ref: '#/definitions/UserRequest'
responses:
'200':
description: Usuário criado com sucesso
schema:
$ref: '#/definitions/UserResponse'
'/v1/users/signin':
post:
tags:
- 'Usuário'
summary: 'Relizar login por usuário/senha'
description: ''
security: []
operationId: users_signin
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: User request object
required: true
schema:
$ref: '#/definitions/UserSigninRequest'
responses:
'200':
description: Usuário logado com sucesso
schema:
$ref: '#/definitions/UserResponse'
'401':
description: Usuário ou senha inválido
'/v1/users/{user_id}':
parameters:
- name: user_id
in: path
description: identificador do usuário
required: true
type: string
put:
tags:
- 'Usuário'
summary: 'Alterar detalhes de usuário'
description: ''
operationId: users_put
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: User request object
required: true
schema:
$ref: '#/definitions/UserUpdateRequest'
responses:
'200':
description: Usuário alterado com sucesso
schema:
$ref: '#/definitions/UserResponse'
get:
tags:
- 'Usuário'
summary: 'Recuperar detalhes de usuário'
description: ''
operationId: users_id_put
produces:
- application/json
responses:
'200':
description: Usuário recuperado com sucesso
schema:
$ref: '#/definitions/UserResponse'
delete:
tags:
- 'Usuário'
summary: 'Remover usuário'
description: ''
operationId: users_id_delete
produces:
- application/json
responses:
'200':
description: Usuário removido com sucesso
'/v1/marketplaces/{marketplace_id}/api_keys':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
post:
tags:
- 'API Key'
summary: 'Criar nova API Key por marketplace'
description: ''
operationId: apikeys_post
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Chave de API
required: true
schema:
$ref: '#/definitions/ApiKeyRequest'
responses:
'200':
description: Chave de API criado com sucesso
schema:
$ref: '#/definitions/ApiKeyResponse'
get:
tags:
- 'API Key'
summary: 'Listar chaves de API por marketplace'
description: ''
operationId: apikeys_get
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
produces:
- application/json
responses:
'200':
description: API Key recuperada com sucesso
schema:
$ref: '#/definitions/ApiKeysList'
'/v1/marketplaces/{marketplace_id}/api_keys/{apikey_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
- name: apikey_id
in: path
description: identificador do api key
required: true
type: string
get:
tags:
- 'API Key'
summary: 'Recuperar detalhes de um API Key'
description: ''
operationId: apikeys_id_get
produces:
- application/json
responses:
'200':
description: Chave de API recuperado com sucesso
schema:
$ref: '#/definitions/ApiKeyResponse'
delete:
tags:
- 'API Key'
summary: 'Remover API Key'
description: ''
operationId: apikeys_id_delete
produces:
- application/json
responses:
'200':
description: API Key recuperada com sucesso
'/v1/marketplaces':
post:
tags:
- 'Marketplace'
summary: 'Criar novo marketplace'
description: ''
operationId: marketplaces_post
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Marketplace criado com sucesso
'400':
description: Requisição inválida
'/v1/marketplaces/{marketplace_id}':
parameters:
- name: marketplace_id
in: path
description: identificador do marketplace
required: true
type: string
get:
tags:
- 'Marketplace'
summary: 'Recuperar detalhes do marketplace'
description: ''
operationId: marketplaces_get
produces:
- application/json
responses:
'200':
description: Marketplace criado com sucesso
schema:
example: |
{
"id": "3249465a7753536b62545a6a684b0000",
"resource": "marketplace",
"name": "Zoop Test Marketplace",
"type": "business_test",
"description": "Zoop test marketplace",
"is_active": true,
"is_verified": true,
"account_balance": "2422678.30",
"current_balance": "0.00",
"decline_on_fail_security_code": false,
"decline_on_fail_zip_code": false,
"support_email": "[email protected]",
"phone_number": "2024356789",
"statement_descriptor": "Zoop Inc.",
"website": "http://getzoop.com",
"facebook": "http://facebook.com/getzoop",
"twitter": "http://twitter.com/getzoop",
"customer": {
"id": "c7e3cb5fcb724201ad0925e29004df1b",
"status": "active",
"resource": "seller",
"type": "business",
"description": null,
"account_balance": "0.00",
"current_balance": "0.00",
"business_name": "Zoop Inc",
"business_phone": " 12026256754",
"business_email": "[email protected]",
"business_website": "https://pagzoop.com",
"business_description": "The open mobile payment platform",
"business_opening_date": null,
"business_facebook": "http://fb.com/getzoop",
"business_twitter": "http://twitter.com/getzoop",
"ein": "253912384",
"statement_descriptor": null,
"mcc": null,
"business_address": {
"line1": "167 West 74th Street",
"line2": null,
"line3": null,
"neighborhood": null,
"city": "Washington",
"state": null,
"postal_code": "10023",
"country_code": "US"
},
"owner": {
"first_name": "Fabiano",
"last_name": "Cruz",
"email": "[email protected]",
"phone_number": " 12029579543",
"taxpayer_id": null,
"birthdate": "1982-12-15",
"address": {
"line1": null,
"line2": null,
"line3": null,
"neighborhood": null,
"city": null,
"state": null,
"postal_code": null,
"country_code": null
}
},
"show_profile_online": false,
"is_mobile": false,
"decline_on_fail_security_code": false,
"decline_on_fail_zipcode": false,
"delinquent": false,
"payment_methods": null,
"default_debit": null,
"default_credit": null,
"merchant_code": "012000000000001",
"terminal_code": "GT0000CA",
"uri": "/v1/marketplaces/3249465a7753536b62545a6a684b0000/sellers/businesses/c7e3cb5fcb724201ad0925e29004df1b",
"metadata": {},
"created_at": "2014-03-28T05:52:08+00:00",
"updated_at": "2014-11-26T04:15:00+00:00"
},
"api_keys": [
{
"id": "7705b333cb884d099d94df43009ad515",
"resource": "api_key",
"type": "test_key",
"name": null,
"test_key": "************",
"publishable_test_key": "zpk_test_EzCkzFFKibGQU6HFq7EYVuxI",
"production_key": null,
"publishable_production_key": null,
"uri": "/v1/marketplaces/3249465a7753536b62545a6a684b0000/api_keys/7705b333cb884d099d94df43009ad515",
"metadata": {},
"created_at": "1970-01-01T00:00:00+00:00",
"updated_at": "1970-01-01T00:00:00+00:00"
}
],
"transfer_enabled": true,
"transfer_policy": "daily",
"debit_enabled": true,
"default_debit": null,
"default_credit": null,
"uri": "/v1/marketplaces/3249465a7753536b62545a6a684b0000",
"created_at": "2013-07-31T11:00:00+00:00",
"updated_at": "2017-07-11T15:19:19+00:00",
"metadata": []
}
'404':
description: Marketplace não encontrado
/v2/marketplaces/{marketplace_id}/plans:
get:
tags:
- Planos
summary: Listar planos por marketplace
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/PlanResponse'
400:
description: bad input parameter
post:
tags:
- Planos
summary: Criar um plano
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: plan to add
schema:
$ref: '#/definitions/PlanRequest'
responses:
201:
description: plano criado com sucesso
400:
description: invalid input, object invalid
409:
description: an item already exists
/v2/marketplaces/{marketplace_id}/plans/{plan_id}:
get:
tags:
- Planos
summary: Recupera um plano pelo identificador
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: path
name: plan_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
$ref: '#/definitions/PlanResponseItem'
400:
description: bad input parameter
put:
tags:
- Planos
summary: Alterar plano pelo identificador
description: Alterar detalhes de um plano existente pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: plan_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: plan to add
schema:
$ref: '#/definitions/PlanRequest'
responses:
200:
description: item updated
400:
description: invalid input, object invalid
delete:
tags:
- Planos
summary: Deletar um plano pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: plan_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: item deleted
400:
description: invalid input, object invalid
/v2/marketplaces/{marketplace_id}/subscriptions:
get:
tags:
- Assinaturas
summary: Recuperar todas as assinatura de um marketplace
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/SubscriptionResponse'
400:
description: bad input parameter
post:
tags:
- Assinaturas
summary: Criar uma assinatura entre um comprador e um plano
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: subscription to add
schema:
$ref: '#/definitions/SubscriptionRequest'
responses:
201:
description: item created
400:
description: invalid input, object invalid
409:
description: item already exists
/v2/marketplaces/{marketplace_id}/subscriptions/{subscription_id}:
get:
tags:
- Assinaturas
summary: Recuperar os detalhes de uma assinatura pelo identificador
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: path
name: subscription_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
$ref: '#/definitions/SubscriptionResponseItem'
400:
description: bad input parameter
put:
tags:
- Assinaturas
summary: Alterar os detalhes de uma assinatura pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: subscription_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: plan to add
schema:
$ref: '#/definitions/SubscriptionRequest'
responses:
200:
description: item updated
400:
description: invalid input, object invalid
delete:
tags:
- Assinaturas
summary: Remover uma assinatura pelo identificador
description: |
Assinatura é a relação entre um plano e um cliente. Possui uma data de início e representa um contrato de recorrência firmado entre o cliente e o parceiro.
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: subscription_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: item deleted
400:
description: invalid input, object invalid
/v2/marketplaces/{marketplace_id}/invoices:
get:
tags:
- Faturas
summary: Recuperar todas as faturas de um marketplace
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/InvoiceResponse'
400:
description: bad input parameter
post:
tags:
- Faturas
summary: Criar uma fatura avulsa
description: |
A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente. Uma conta telefônica é um exemplo de fatura que você pode relacionar com seu cotidiano. Uma fatura pode conter vários itens: "Assinatura mensal", "Suporte técnico adicional", "Mensagens enviadas", etc.
Faturas podem existir independente de assinaturas e neste caso elas são chamadas de "faturas avulsas" e são ligadas diretamente ao cliente.
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: invoice
description: invoice to add
schema:
$ref: '#/definitions/InvoiceRequest'
responses:
201:
description: item created
400:
description: invalid input, object invalid
409:
description: item already exists
/v2/marketplaces/{marketplace_id}/invoices/{invoice_id}:
get:
tags:
- Faturas
summary: Recuperar os detalhes de uma fatura pelo identificador
description: |
Você pode recuperar os detalhes de uma determinada fatura através do identificador
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: path
name: invoice_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
$ref: '#/definitions/InvoiceResponseItem'
400:
description: bad input parameter
put:
tags:
- Faturas
summary: Alterar detalhes de uma fatura pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: invoice_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: plan to add
schema:
$ref: '#/definitions/InvoiceRequest'
responses:
200:
description: item updated
400:
description: invalid input, object invalid
delete:
tags:
- Faturas
summary: Remover uma fatura pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: invoice_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: item deleted
400:
description: invalid input, object invalid
/v2/marketplaces/{marketplace_id}/invoices/{invoice_id}/approve:
post:
tags:
- Faturas
summary: Aprovar fatura pendente
description: |
Aprovar manualmente uma fatura pendente, sem que seja feita a cobrança ao cobrador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: invoice_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: invoice approved
400:
description: invalid input, object invalid
/v2/marketplaces/{marketplace_id}/invoices/{invoice_id}/void:
post:
tags:
- Faturas
summary: Estornar e reembolsar fatura
description: |
Estornar uma fatura paga, sendo feito o processamento do estorno da forma de cobrança associada ao pagamento da fatura;
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: invoice_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: fatura estornado com sucesso
400:
description: invalid input, object invalid
/v2/marketplaces/{marketplace_id}/sellers/{customer_id}/invoices:
get:
tags:
- Faturas
summary: Recuperar faturas associadas a um vendedor pelo identificador
description: |
Recuperar os detalhes de todas as faturas associadas a um determinado vendedor pelo identificador
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
- in: path
name: marketplace_id
required: true
type: string
- in: path
name: customer_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/InvoiceResponse'
400:
description: bad input parameter
/v2/marketplaces/{marketplace_id}/discounts:
get:
tags:
- Descontos
summary: Recuperar todos os descontos associados a um marketplace pelo identificador
produces:
- application/json
parameters:
- $ref: '#/parameters/limitParam'
- $ref: '#/parameters/sortParam'
- $ref: '#/parameters/offsetParam'
- $ref: '#/parameters/dateRangeParam'
- $ref: '#/parameters/dateRangeGTParam'
- $ref: '#/parameters/dateRangeGTEParam'
- $ref: '#/parameters/dateRangeLTParam'
- $ref: '#/parameters/dateRangeLTEParam'
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/DiscountResponse'
400:
description: bad input parameter
post:
tags:
- Descontos
summary: Criar um desconto
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: discount to add
schema:
$ref: '#/definitions/DiscountRequest'
responses:
201:
description: item created
400:
description: invalid input, object invalid
409:
description: item already exists
/v2/marketplaces/{marketplace_id}/discounts/{discount_id}:
get:
tags:
- Descontos
summary: Recuperar detalhes de um desconto pelo identificador
produces:
- application/json
parameters:
- in: path
name: marketplace_id
required: true
type: string
- in: path
name: discount_id
required: true
type: string
responses:
200:
description: search results matching criteria
schema:
$ref: '#/definitions/DiscountResponseItem'
400:
description: bad input parameter
put:
tags:
- Descontos
summary: Alterar detalhes de um desconto pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: discount_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
- in: body
name: plan
description: discount to add
schema:
$ref: '#/definitions/DiscountRequest'
responses:
200:
description: item updated
400:
description: invalid input, object invalid
delete:
tags:
- Descontos
summary: Remover um desconto pelo identificador
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: discount_id
required: true
type: string
- in: path
name: marketplace_id
required: true
type: string
responses:
200:
description: item deleted
400:
description: invalid input, object invalid
definitions:
Documents:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/sellers/582dcc754cef4e6e8ed3134067c2f76b/documents"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/Document'
Document:
type: object
properties:
id:
type: string
example: 00dad23fae8b49638f6b897f6b7df5c2
name:
type: string
example: 59d7d71a9b617.pdf
status:
type: string
enum:
- pending
- uploaded
- reviewving
- action_required
- approved
- published
- rejected
- archived
- deleted
example: pending
path:
type: string
example: https://static-assetss.s3.amazonaws.com/59d7d71a9b617.pdf
extension:
type: string
example: pdf
mime_type:
type: string
example: application/pdf
size:
type: integer
example: 11401
md5:
type: string
example: 02136adef2c29815d97902147069b23c
description:
type: string
example: "documento de identificacao"
category:
type: string
enum:
- identification
- address
- activity
- ein
example: identification
uploaded_by:
type: object
properties:
id:
type: string
example: ab22b0c077e04099afa144d375cbf293
resource:
type: string
enum:
- seller
- buyer
- marketplace
example: seller
type:
type: string
enum:
- individual
- business
example: individual
uploaded_ip:
type: string
metadata:
type: object
Business:
type: object
properties:
id:
type: string
example: 17d9e827664b47509f12a082b6047e7a
description: Identificador exclusivo para este vendedor
status:
type: string
enum:
- new
- expired
- action_required
- pending
- enabled
- active
- disabled
- deleted
example: pending
resource:
type: string
example: seller
type:
type: string
enum:
- individual
- business
example: business
account_balance:
type: number
example: 0.00
current_balance:
type: number
example: 0.00
fiscal_responsibility:
type: string
description: 'ID de vendedor responsável por receber os créditos pelas vendas'
owner:
type: object
properties:
first_name:
type: string
example: José
last_name:
type: string
example: Da Silva
email:
type: string
example: [email protected]
phone_number:
type: string
example: " 12029579543"
taxpayer_id:
type: string
example: "76537741807"
birthdate:
type: string
example: "1982-12-15"
description:
type: string
example:
business_name:
type: string
example: "Zoop Inc"
business_phone:
type: string
example: "12026256754"
business_email:
type: string
example: "[email protected]"
business_website:
type: string
example: "http://getzoop.com"
business_description:
type: string
example: "The open mobile payment platform"
business_facebook:
type: string
example: "http://fb.com/getzoop"
business_twitter:
type: string
example: "http://twitter.com/getzoop"
ein:
type: string
example: "24742492000159"
business_address:
type: object
properties:
line1:
type: string
example: "167 West 74th Street"
line2:
type: string
example: "543"
line3:
type: string
example: "APT 601"
neighborhood:
type: string
example: "Downtown"
city:
type: string
example: "Washington"
state:
type: string
example: "DC"
description: Código ISO 3166-2 para o estado
postal_code:
type: string
example: "10023"
country_code:
type: string
example: "BR"
description: ISO 3166-1 alpha-2 - códigos de país de duas letras.
owner_address:
type: object
properties:
line1:
type: string
example: "167 West 74th Street"
line2:
type: string
example: "543"
line3:
type: string
example: "APT 601"
neighborhood:
type: string
example: "Downtown"
city:
type: string
example: "Washington"
state:
type: string
example: "DC"
postal_code:
type: string
example: "10023"
country_code:
type: string
example: "US"
delinquent:
type: boolean
default_debit:
type: string
description: 'O método de pagamento padrão (cartão ou conta bancária) associado a um vendedor que será usado, por exemplo, para debitar a conta bancária ou cartão de crédito'
default_credit:
type: string
description: 'O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária'
mcc:
type: string
example: "1"
description: MCC ID
metadata:
type: object
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
Individuals:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/sellers"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/Individual'
Individual:
type: object
properties:
id:
type: string
example: 17d9e827664b47509f12a082b6047e7a
status:
type: string
enum:
- new
- expired
- action_required
- pending
- enabled
- active
- disabled
- deleted
example: pending
resource:
type: string
example: seller
type:
type: string
enum:
- individual
- business
example: individual
account_balance:
type: number
example: 0.00
current_balance:
type: number
example: 0.00
fiscal_responsibility:
type: string
description: 'ID de vendedor responsável por receber os créditos pelas vendas'
first_name:
type: string
example: José
last_name:
type: string
example: Da Silva
email:
type: string
example: [email protected]
phone_number:
type: string
example: " 12029579543"
taxpayer_id:
type: string
example: "76537741807"
birthdate:
type: string
example: "1982-12-15"
description:
type: string
example:
address:
type: object
properties:
line1:
type: string
example: "167 West 74th Street"
line2:
type: string
example: "543"
line3:
type: string
example: "APT 601"
neighborhood:
type: string
example: "Downtown"
city:
type: string
example: "Washington"
state:
type: string
example: "DC"
postal_code:
type: string
example: "10023"
country_code:
type: string
example: "US"
delinquent:
type: boolean
default_debit:
type: string
description: 'cartão default para compras'
default_credit:
type: string
description: 'conta bancaria default para depositios'
mcc:
type: string
example: "1"
description: MCC ID
metadata:
type: object
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
Transactions:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/transactions"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
$ref: '#/definitions/TransactionResponse'
TransactionResponse:
type: object
properties:
id:
type: string
example: 0009462369b14ee596aabfd27faa97f7
status:
type: string
enum:
- new
- pending
- succeeded
- canceled
- reversed
- failed
- pre_authorized
example: succeeded
resource:
type: string
example: transaction
amount:
type: string
example: "1.00"
original_amount:
type: string
example: "1.00"
currency:
type: string
example: "BRL"
description:
type: string
example: "BRL"
payment_type:
enum:
- credit
- debit
- wallet
- boleto
example: credit
transaction_number:
type: string
example: "W-12343124"
sales_receipt:
type: string
example: "00d5ce5086c84c0f824cf660b020881a"
on_behalf_of:
type: string
example: "1e5ee2e290d040769806c79e6ef94ee1"
statement_descriptor:
type: string
example: "CORRENTISTA 03 3011"
payment_method:
type: object
properties:
id:
type: string
example: "2f008ac254964e658be566241cc87c1a"
resource:
type: string
example: "card"
description:
type: string
example: null
card_brand:
type: string
example: "Visa"
first4_digits:
type: string
example: "4893"
last4_digits:
type: string
example: null
expiration_month:
type: string
example: "7"
expiration_year:
type: string
example: "2023"
holder_name:
type: string
example: "LEITE/ANDRE S DE M"
is_active:
type: boolean
example: false
is_valid:
type: boolean
example: true
is_verified:
type: boolean
example: false
customer:
type: string
example: "e4e8c5b569da48b28d896385f5481bcf"
fingerprint:
type: string
example: "9f2843f0c1b08d6018927b4e5e884a869ae49"
uri:
type: string
example: "/v1/marketplaces/3249465a7753536b62545a6a684b0000/cards/2f008ac254964e658be566241cc87c1a"
metadata:
type: object
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
point_of_sale:
type: object
properties:
entry_mode:
type: string
enum:
- manually_keyed
- magstripe
- barcode
- ocr
- chip
- contactless_chip
- magstripe_fallback
- manually_keyed_fallback
- contactless_magstripe
example: "chip"
identification_number:
type: string
example: "4b7d03e6aa01463bb5673f04a7717db9"
refunded:
type: boolean
example: false
voided:
type: boolean
example: false
captured:
type: boolean
example: false
fees:
type: string
example: "0.05"
fee_details:
type: object
properties:
amount:
type: string
example: "0.05"
prepaid:
type: boolean
example: true
currency:
type: string
example: "BRL"
type:
type: string
example: "zoop_credit_fee_d0"
description:
type: string
example: "Zoop prepaid card-present credit fee"
uri:
type: string
example: |
/v1/marketplaces/3249465a7753536b62545a6a684b0000/transactions/0009462369b14ee596aabfd27faa97f7
metadata:
type: object
expected_on:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
TransactionUpdateRequest:
type: object
properties:
description:
type: string
example: "BRL"
metadata:
type: object
TransactionCNPRequest:
type: object
required:
- amount
- currency
- description
- payment_type
- on_behalf_of
properties:
amount:
type: string
example: "1.00"
currency:
type: string
example: "BRL"
description:
type: string
example: "BRL"
payment_type:
enum:
- credit
- debit
- wallet
- boleto
example: credit
on_behalf_of:
type: string
example: "1e5ee2e290d040769806c79e6ef94ee1"
statement_descriptor:
type: string
example: "CORRENTISTA 03 3011"
customer:
type: string
description: identificador do comprador que será cobrado
example: "1e5ee2e290d040769806c79e6ef94ee1"
token:
type: string
description: identificador do token de cartão que será cobrado
example: "1e5ee2e290d040769806c79e6ef94ee1"
metadata:
type: object
Transfer:
type: object
properties:
amount:
type: integer
example: 3500
statement_descriptor:
type: string
example: Zoop Tecnologia
description:
type: string
example: Saque dia 24.09.2017
TransferP2P:
type: object
properties:
amount:
type: integer
example: 3500
description:
type: string
example: Cobrança de mensalidade
ReceivingPolicy:
type: object
properties:
transfer_interval:
type: string
enum:
- daily
- weekly
- monthly
default: daily
example: daily
transfer_day:
type: integer
example: 1
transfer_enabled:
type: boolean
example: true
minimum_transfer_value:
type: integer
example: 100
BankAccount:
type: object
properties:
customer:
type: string
example: 064bf90479e34865afb90cc4a0efe2cc
token:
type: string
example: 2d55be7859544074a7ae9ffe60fdf6d9
TokenCardRequest:
type: object
properties:
holder_name:
type: string
description: Nome do portador
expiration_month:
type: string
description: mês de expiração do cartão (MM)
expiration_year:
type: string
description: ano de expiração do cartão (AAAA)
card_number:
type: string
description: Número do cartão
PermissionResponse:
type: object
properties:
resource:
type: string
example: "permissions"
uri:
type: string
example: "/v1/users/d6cf41c2-caa1-4e54-a170-ba078f5dfe53/permissions"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
user_id:
type: string
example: c6cf41c2-caa1-4e54-a170-ba078f5dfe53
items:
type: array
items:
$ref: '#/definitions/UserPermissioResponse'
PermissionRequest:
type: object
required:
- user
- service
- action
- resource
properties:
user:
description: ID do usuário
type: string
example: d6cf41c2-caa1-4e54-a170-ba078f5dfe53
marketplace:
description: ID do marketplace
type: string
example: f6cf41c2-caa1-4e54-a170-ba078f5dfe53
customer:
description: ID do customer
type: string
example: e6cf41c2-caa1-4e54-a170-ba078f5dfe53
service:
description: Nome do serviço para qual irá criar permissão
type: string
example: "buyers"
resource:
description: recurso do serviço para qual irá criar permissão
type: string
example: "individuals"
action:
type: string
description: Tipo de ações que a permissão irá permitir
example: "GET"
UserRequest:
type: object
required:
- email
- username
- password
properties:
email:
description: E-mail do usuário
type: string
first_name:
description: Primeiro nome do usuário
type: string
last_name:
description: Primeiro nome do usuário
type: string
username:
description: Identificador do usuário utilizado no login
type: string
password:
description: Senha do usuário utilizado no login
type: string
metadata:
type: object
UserUpdateRequest:
type: object
properties:
email:
description: E-mail do usuário
type: string
username:
description: Identificador do usuário utilizado no login
type: string
password:
description: Senha do usuário utilizado no login
type: string
UserResponse:
type: object
properties:
id:
type: string
example: 4B53764E831B48BA8F65B70B525C3A5C
resource:
type: string
example: "user"
token:
description: User Token API à ser utilizado nas requisições
type: string
example: "N2JlODhhMzItY2VkNy00NTM1LWIzMTItODZhNmVmOGUwMzMx"
email:
description: E-mail do usuário
type: string
example: "[email protected]"
first_name:
description: Primeiro nome do usuário
type: string
example: Joao
last_name:
description: Primeiro nome do usuário
type: string
example: Das Neves
username:
description: Identificador do usuário utilizado no login
type: string
example: "[email protected]"
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
uri:
type: string
example: /v1/users/4B53764E831B48BA8F65B70B525C3A5C
UserSigninRequest:
type: object
required:
- username
- password
properties:
username:
description: Identificador do usuário utilizado no login
type: string
password:
description: Senha do usuário utilizado no login
type: string
ApiKeyRequest:
type: object
required:
- name
properties:
name:
description: Nome da chave de acesso a API
type: string
metadata:
type: object
ApiKeyResponse:
type: object
properties:
id:
type: string
example: 7705b333cb884d099d94df43009ad515
resource:
type: string
example: "api_key"
type:
description: Tipo da chave
type: string
enum:
- test_key
- production_key
name:
description: Nome da chave
type: string
example: Integração
test_key:
description: Chave de teste privada
type: string
example: "*********"
publishable_test_key:
description: Chave de teste pública
type: string
example: zpk_test_EzCkzFFKibGQU6HFq7EYVuxI
production_key:
description: Chave produção privada
type: string
publishable_production_key:
description: Chave produção pública
type: string
metadata:
type: object
created_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
updated_at:
type: string
format: dateTime
example: "2015-04-17T06:39:52+00:00"
uri:
type: string
example: /v1/marketplaces/3249465a7753536b62545a6a684b0000/api_keys/7705b333cb884d099d94df43009ad515
ApiKeysList:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/api_keys"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
$ref: '#/definitions/ApiKeyResponse'
UserPermissioResponse:
type: object
properties:
id:
type: string
example: a6cf41c2caa14e54a170-ba078f5dfe53
hash:
type: string
description: acl:client:marketplace_id:seller_id:service:resource:action
example: client:a6cf41c2-caa1-4e54-a170-ba078f5dfe53:c6cf41c2-caa1-4e54-a170-ba078f5dfe53:buyers:individuals:GET
user:
description: ID do usuário
type: string
example: d6cf41c2caa14e54a170ba078f5dfe53
marketplace:
description: ID do marketplace
type: string
example: f6cf41c2caa14e54a170ba078f5dfe53
customer:
description: ID do customer
type: string
example: e6cf41c2caa14e54a170ba078f5dfe53
service:
description: Nome do serviço para qual irá criar permissão
type: string
example: "buyers"
resource:
description: recurso do serviço para qual irá criar permissão
type: string
example: "individuals"
action:
type: string
description: Tipo de ações que a permissão irá permitir
example: "GET"
created_at:
type: integer
format: int32
uri:
type: string
example: "/v1/users/d6cf41c2-caa1-4e54-a170-ba078f5dfe53/permissions"
PlanRequest:
type: object
required:
- frequency
- interval
- payment_methods
properties:
frequency:
description: Frequencia que o plano será cobrado
type: string
enum:
- daily
- monthly
- weekly
- annually
interval:
description: intervalo entre frequencia de cobrança
type: integer
format: int32
payment_methods:
description: métodos de pagamento utilizados
type: string
enum:
- boleto
- credit
- debit
- wallet
amount:
description: valor plano em centavos
type: integer
format: int32
setup_amount:
description: valor do setup do plano em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
description:
description: descrição do plano
type: string
name:
description: nome do plano
type: string
grace_period:
description: perído (dias) de carência para a primeira cobrança do plano
type: integer
format: int32
tolerance_period:
description: perído de tolerancia caso haja falha de pagamento
type: integer
format: int32
duration:
description: tempo de duração do plano em relação à frequencia escolhida
type: integer
format: int32
status:
description: status do plano
type: string
enum:
- active
- canceled
PlanResponse:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/plan/"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/PlanResponseItem'
PlanResponseItem:
type: object
required:
- frequency
- interval
- payment_methods
properties:
id:
type: string
format: uuid
readOnly: true
example: d290f1ee6c544b0190e6d701748f0851
frequency:
description: Frequencia que o plano será cobrado
type: string
enum:
- daily
- monthly
- weekly
- annually
interval:
description: intervalo entre frequencia de cobrança
type: integer
format: int32
payment_methods:
description: métodos de pagamento utilizados
type: string
enum:
- boleto
- credit
- debit
- wallet
amount:
description: valor plano em centavos
type: integer
format: int32
setup_amount:
description: valor do setup do plano em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
description:
description: descrição do plano
type: string
name:
description: nome do plano
type: string
grace_period:
description: perído (dias) de carência para a primeira cobrança do plano
type: integer
format: int32
tolerance_period:
description: perído de tolerancia caso haja falha de pagamento
type: integer
format: int32
duration:
description: tempo de duração do plano em relação à frequencia escolhida
type: integer
format: int32
status:
description: status do plano
type: string
enum:
- active
- canceled
resource:
type: string
example: plan
metadata:
type: array
items:
- type: string
created_at:
type: integer
format: int32
updated_at:
type: integer
format: int32
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/plan/73c0789594c1470cb10cc957f2435c00"
SubscriptionRequest:
type: object
properties:
plan:
description: referência a um plano existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
on_behalf_of:
description: referência a um vendedor existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
customer:
description: referência a um comprador existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
description:
description: descrição da assinatura
type: string
format: text
payment_methods:
description: métodos de pagamentos
type: string
enum:
- boleto
- credit
- debit
- wallet
due_date:
description: data da próxima cobrança
type: string
format: date
example: 2017-07-21
due_since_date:
description: data da primeira cobrança da assinatura
type: string
format: date
example: 2017-07-21
expiration_date:
description: data final da assinatura
type: string
format: date
example: 2017-07-25
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
grace_period:
description: perído (dias) de carência para a primeira cobrança da assinatura
type: integer
format: int32
tolerance_period:
description: perído de tolerancia caso haja falha de pagamento
type: integer
format: int32
status:
description: status da assinatura
type: string
enum:
- active
- suspended
- canceled
- expired
SubscriptionResponse:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/subscription/"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/SubscriptionResponseItem'
SubscriptionResponseItem:
type: object
properties:
id:
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
plan:
description: referência a um plano existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
on_behalf_of:
description: referência a um vendedor existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
customer:
description: referência a um comprador existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
description:
description: descrição da assinatura
type: string
format: text
payment_methods:
description: métodos de pagamentos
type: string
enum:
- boleto
- credit
- debit
- wallet
due_date:
description: data da próxima cobrança
type: string
format: date
example: 2017-07-21
due_since_date:
description: data da primeira cobrança da assinatura
type: string
format: date
example: 2017-07-21
expiration_date:
description: data final da assinatura
type: string
format: date
example: 2017-07-25
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
grace_period:
description: perído (dias) de carência para a primeira cobrança da assinatura
type: integer
format: int32
tolerance_period:
description: perído de tolerancia caso haja falha de pagamento
type: integer
format: int32
status:
description: status da assinatura
type: string
enum:
- active
- suspended
- canceled
- expired
resource:
type: string
example: subscription
metadata:
type: array
items:
- type: string
created_at:
type: integer
format: int32
updated_at:
type: integer
format: int32
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/subscription/73c0789594c1470cb10cc957f2435c00"
DiscountRequest:
type: object
properties:
plan:
description: referência a um plano existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
subscription:
description: referência a uma assinatura existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
discount_type:
description: tipo de desconto, porcentagem ou valor bruto
type: string
enum:
- percentage
- raw
due_start:
description: data de início do desconto
type: string
format: date
example: 2017-07-21
due_end:
description: data de fim do desconto
type: string
format: date
example: 2017-07-21
is_cumulative:
description: informa se o desconto é acumulativo com outros descontos
type: boolean
status:
description: status do desconto
type: string
enum:
- active
- suspended
- canceled
- expired
DiscountResponse:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/discount/"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/DiscountResponseItem'
DiscountResponseItem:
type: object
properties:
id:
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
plan:
description: referência a um plano existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
subscription:
description: referência a uma assinatura existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
discount_type:
description: tipo de desconto, porcentagem ou valor bruto
type: string
enum:
- percentage
- raw
due_start:
description: data de início do desconto
type: string
format: date
example: 2017-07-21
due_end:
description: data de fim do desconto
type: string
format: date
example: 2017-07-21
is_cumulative:
description: informa se o desconto é acumulativo com outros descontos
type: boolean
status:
description: status do desconto
type: string
enum:
- active
- suspended
- canceled
- expired
resource:
type: string
example: discount
metadata:
type: array
items:
- type: string
created_at:
type: integer
format: int32
updated_at:
type: integer
format: int32
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/discount/73c0789594c1470cb10cc957f2435c00"
InvoiceRequest:
type: object
properties:
subscription:
description: referência a uma assinatura existente
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
on_behalf_of:
description: referência a um vendedor existente
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
customer:
description: referência a um comprador existente
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
description:
description: descrição da assinatura
type: string
format: text
payment_methods:
description: métodos de pagamentos
type: string
enum:
- boleto
- credit
- debit
- wallet
due_date:
description: data da próxima cobrança
type: string
format: date
example: 2017-07-21
expiration_date:
description: data de vencimento cobrança
type: string
format: date
example: 2017-07-25
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
paid_at:
description: data do pagamento
type: integer
format: int32
voided_at:
description: data do cancelamento
type: integer
format: int32
grace_period:
description: período de carência após cobrança gerada
type: integer
format: int32
tolerance_period:
description: período de tolerância caso haja falha no pagamento
type: integer
format: int32
retries:
description: quantidade de vezes que tentou efetuar o pagamento
type: integer
format: int32
max_retries:
description: quantidade máxima de vezes que se deve tentar efetuar o pagamento
type: integer
format: int32
status:
description: status da cobrança
type: string
enum:
- pending
- paid
- canceled
- failed
InvoiceResponse:
type: object
properties:
resource:
type: string
example: "list"
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/invoice/"
limit:
type: number
example: 100
offset:
type: number
example: 0
has_more:
type: boolean
example: false
query_count:
type: number
example: 2
total:
type: number
example: 2
items:
type: array
items:
$ref: '#/definitions/InvoiceResponseItem'
InvoiceResponseItem:
type: object
properties:
id:
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
subscription:
description: referência a uma assinatura existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
on_behalf_of:
description: referência a um vendedor existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
customer:
description: referência a um comprador existente
type: string
format: uuid
example: d290f1ee6c544b0190e6d701748f0851
description:
description: descrição da assinatura
type: string
format: text
payment_methods:
description: métodos de pagamentos
type: string
enum:
- boleto
- credit
- debit
- wallet
due_date:
description: data da próxima cobrança
type: string
format: date
example: 2017-07-21
expiration_date:
description: data de vencimento cobrança
type: string
format: date
example: 2017-07-25
amount:
description: valor em centavos
type: integer
format: int32
currency:
description: moeda utilizada
type: string
example: BRL
paid_at:
description: data do pagamento
type: integer
format: int32
voided_at:
description: data do cancelamento
type: integer
format: int32
grace_period:
description: período de carência após cobrança gerada
type: integer
format: int32
tolerance_period:
description: período de tolerância caso haja falha no pagamento
type: integer
format: int32
retries:
description: quantidade de vezes que tentou efetuar o pagamento
type: integer
format: int32
max_retries:
description: quantidade máxima de vezes que se deve tentar efetuar o pagamento
type: integer
format: int32
status:
description: status da cobrança
type: string
enum:
- pending
- paid
- canceled
- failed
resource:
type: string
example: invoice
metadata:
type: array
items:
- type: string
created_at:
type: integer
format: int32
updated_at:
type: integer
format: int32
uri:
type: string
example: "/v1/marketplaces/820a6bda73c546a8b2f12a5ebcae7732/invoice/73c0789594c1470cb10cc957f2435c00"
parameters:
userIdParam:
name: user_id
in: path
description: ID user
required: true
type: string
marketplaceParam:
name: marketplace_id
in: path
description: ID marketplace
required: true
type: string
permissionIdParam:
name: permission_id
in: path
description: ID permission
required: true
type: string
limitParam:
name: limit
in: query
description: Limita o número de objetos retornados, podendo ser entre 1 e 100
required: false
type: number
format: int32
default: 20
sortParam:
name: sort
in: query
description: Determinar como ordenar a lista em relação a data de criação do objeto
required: false
type: string
enum:
- time-descending
- time-ascending
default: time-descending
offsetParam:
name: offset
in: query
description: Determina o ponto de inicio dos registros retornados
required: false
type: number
format: int32
default: 0
dateRangeParam:
name: date_range
in: query
description: Filtro na lista base de objetos pela data de criação. O valor pode ser uma string com um horário em UTC timestamp, ou pode ser uma lista com os parametros abaixo
required: false
type: number
dateRangeGTParam:
name: date_range[gt]
in: query
description: Retorna valores onde a data maior que o timestamp informado
required: false
type: number
dateRangeGTEParam:
name: date_range[gte]
in: query
description: Retorna valores onde a data for maior ou igual que o timestamp informado
required: false
type: number
dateRangeLTParam:
name: date_range[lt]
in: query
description: Retorna valores onde a data for menor que o timestamp informado
required: false
type: number
dateRangeLTEParam:
name: date_range[lte]
in: query
description: Retorna valores onde a data for menor ou igual que o timestamp informado
required: false
type: number
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment