Zoop Developer Center

Bem-vindo ao hub do desenvolvedor Zoop. Você encontrará guias da API e uma documentação abrangente para ajudá-lo a começar a trabalhar com a Zoop o mais rápido possível, além de ajudá-lo se você tiver algum problema. Vamos lá!

Documentação

Introdução

 

A API Zoop está implementada em conformidade com o princípio de design REST. Nossa API possui recursos orientados a URLs, com códigos HTTP para indicar erros. Nós utilizamos funcionalidades HTTP nativas, como verbos de ação POST, PUT, GET, DELETE, para operações de leitura e escrita, bem como o modelo básico de autenticação HTTP.

Nós suportamos chamadas diretas aos recursos da API a partir de outras origens, CORS (cross-origin resource sharing), permitindo você interagir de maneira segura com nossas APIs a partir de aplicações web, lembrando sempre de utilizar sua chave pública nesses casos, reservando sua chave secreta para chamadas internas de sistema. Todas as respostas da API estão no formato de dados JSON, incluindo errors.

Para permitir que você possa explorar todos os serviços sem preocupação, nossas contas possuem chaves de acesso nos modos de produção (LIVE) e teste (TEST). Não é possível alternar entre modos, basta usar a chave apropriada para realizar operações em produção ou ambiente de teste. Chamadas feitas com chaves de teste não são processadas junto a instituições bancárias, facilitando o desenvolvimento.

Fique por dentro de todas as publicações e anúncios de APIs e SDKs da Zoop acessando nossa lista de publicações.

Autenticação Básica

 

Nossas APIs REST permitem autenticação por token. Apenas um administrador de conta pode acessar ou gerar tokens de API.
Quando sua conta está ativada para usar a API, a chave aparecerá na sua área de administrador no link OPÇÕES na seção PE.

A autenticação na API ocorre via autenticação de acesso básico HTTP. Você encontrará mais detalhes sobre Autenticação básica no IETF RFC 2617.

Forneça a sua chave como nome de usuário para a autenticação básica. Você não precisa fornecer uma senha.

Toda a comunicação deve ser criptografada via SSL. O token de autenticação básica é reversível, no entanto, como toda a comunicação é por HTTPS, o contexto de segurança está completamente protegido. Um aplicativo deve enviar um cabeçalho de Autorização HTTP contendo o nome de usuário a cada solicitação.

Todas as chamadas na API devem ser feitas por HTTPS para garantir a segurança.

Toda requisição recebida que não esteja criptografada será considerada comprometida pelo nosso sistema e irá falhar.

A autenticação básica é trivial para usar nas bibliotecas de clients HTTP.
Ferramentas como o CURL fornecem opções de linha de código.

NOTA

Você deverá salvar as suas chaves de API, independentemente de qualquer coisa. NÃO COMPARTILHE suas chaves de API com ninguém, nem mesmo nos canais de suporte da Zoop. Nenhum funcionário da Zoop está autorizado a pedir sua chave de API ou qualquer outro dado sensível!

Testando

 

Quais cartões de crédito você deve usar para testar?

Para testar sua integração sem ter que utilizar cartões de crédito de produção, você deve utilizar o nosso ambiente de testes. Esse ambiente é uma cópia exata do ambiente de produção, porém os cartões de crédito e as contas bancárias não são cobrados.

Você poderá utilizar os seguintes números de cartão de crédito para simular transações de pagamento bem-sucedidas:

Número
Bandeira

4539 0033 7072 5497

Visa (Digitada)

4761 3400 0000 0035

Visa (Chip & PIN)

4716 5888 3636 2104

Visa (Tarja)

4532 6501 0413 7832

Visa Electron (Débito)

5356 0663 2027 1893

MasterCard (Digitada)

5201 5610 5002 4014

MasterCard (Chip & PIN)

5577 2700 0428 6630

MasterCard (Tarja)

5138 6920 3612 5449

MasterCard Maestro (Débito)

Além disso, esses são os números "mágicos" de cartões que gerarão respostas específicas, úteis para testar diferentes cenários:

Número
Descrição

4556 6299 7266 8582

As transações com este cartão serão sempre recusadas com um código de "cartão declinado".

6011 4578 1994 0087

A transação será recusada com um código de "invalid_card_number".

4929 7104 2663 7678

A transação será recusada com um código "expired_card_error".

4710 4267 4321 6178

A transação será recusada com um código "service_request_timeout".

NOTA

Você poderá usar qualquer expiration_month,expiration_year e security_code para transação digitada.
Não utilize esses números de cartões em ambiente de produção!

Códigos de Erro

 

Códigos de Status HTTP

Em poucas palavras, existem apenas 3 resultados na interação entre seu aplicativo e nossa API:

  • Tudo funcionou
  • O aplicativo fez algo errado
  • A API fez algo errado
  • A API Zoop tenta retornar códigos de status de resposta HTTP apropriados para cada solicitação.

Em geral, os códigos no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro necessário faltou, uma transação falhou, etc.) e os códigos no intervalo 5xx indicam um erro com os servidores da Zoop.

A tabela a seguir contém os valores mais comuns para os códigos de status HTTP retornados pela API:

HTTP STATUS CODE
Texto
Descrição

200

OK

Tudo funcionou conforme o esperado.

201

Created

A requisição foi bem sucedida e um novo recurso foi criado.

304

Not Modified

Não havia dados novos para retornar.

400

Bad Request

A requisição foi invalida ou não atingiu o servidor. Muitas vezes, falta um parâmetro obrigatório.

401

Unauthorized

As credenciais de autenticação estavam faltando ou foram incorretas.

402

Request Failed

Os parâmetros foram válidos mas a requisição falhou.

403

Forbidden

A requisição foi ok, mas foi recusado ou o acesso não foi permitido. Uma mensagem de erro que acompanha a mensagem explica o porquê.

404

Not Found

A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído.

500

Internal Server Error

Algo está quebrado. Por favor, assegure-se de que a equipe Zoop esteja investigando.

502

Bad Gateway

A Zoop caiu ou está sendo atualizada.

Mensagens de erro

Quando uma requisição de API falha, a Zoop retornará um código de resposta HTTP 4xx ou 5xx que identifica genericamente a falha, bem como uma resposta JSON que fornece informações mais específicas sobre o erro (ou os erros) que causou a falha.

A resposta conterá:

  • O status e o status_code.
  • O tipo e a categoria que você pode usar para programar as respostas aos erros.
  • Uma mensagem legível para humanos que explica por que o erro ocorreu.
  • Os valores possíveis para o parâmetro de tipo estão listados abaixo:
Status Code
Tipo
Categoria
Descrição
Cod. Erro Bandeira

500

processing_error

server_api_error

Ocorreu um erro de processamento na Zoop. Se você receber esta mensagem, entre em contato com api@pagzoop.com

409

invalid_request_error

duplicate_taxpayer_id

Customer with this taxpayer_id already exists.

408

invalid_request_error

service_request_timeout

Credit card process is temporarily unavailable at the specified location.

404

invalid_request_error

endpoint_not_found

The requested URL was not found on the server

401

invalid_request_error

authentication_failed

The supplied user credentials failed validation for the requested service.

401

invalid_request_error

expired_security_key

The API Key provided has expired or has been deleted.

401

invalid_request_error

invalid_key_for_api_call

This API call cannot be made with a publishable API key.

400

invalid_request_error

transaction_amount_error

The minimum amount is $0.50 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60.

400

invalid_request_error

transfer_amount_error

The minimum transfer amount is $1.00 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60.

400

invalid_request_error

missing_required_param

Missing required parameter(s). Please verify request parameters.

400

invalid_request_error

unsupported_payment_type

Invalid request: unsupported payment type.

400

invalid_request_error

invalid_payment_information

Invalid payment information. Please verify request parameters.

400

invalid_request_error

invalid_parameter

Invalid parameter(s). Your parameter value is incorrect. Please verify request parameters.

402

file_upload

file_size_too_large

402

invalid_request_error

insufficient_escrow_funds_error

Requested transfer exceeds remaining settled funds in escrow.

402

invalid_request_error

capture_transaction_error

The capture request failed. Transaction could not be captured.

402

invalid_request_error

no_action_taken

No action taken. Unable to back out prior transaction

402

invalid_request_error

seller_authorization_refused

Seller has not been authorized to charge credit cards. Complete activation to start processing payments.

402

invalid_request_error

void_transaction_error

The void request failed. Transaction could not be voided.

402

card_error

invalid_expiry_month

Invalid expiry month value. Please verify request parameters.

402

card_error

invalid_expiry_year

Invalid expiry year value. Please verify request parameters.

402

card_error

card_customer_not_associated

Transaction denied. No active card.

402

card_error

insufficient_funds_error

Requested credit exceeds remaining settled funds.

51

402

card_error

expired_card_error

The credit card has expired.

33

402

card_error

invalid_card_number

The card number is not a valid credit card number.

15

402

card_error

invalid_pin_code

Transaction denied. Invalid PIN code.

55

402

card_error

authorization_refused

Transação ilegal

58

Compatibilidade futura

Para compatibilidade futura, interprete os seguintes intervalos de código de status:

  • 200-299 como sucesso,
  • 400-499 como erros de solicitação do cliente,
  • 500-599 como erros de servidor

Vendedor

 

Os vendedores representam pessoas ou empresas dentro do seu marketplace. Normalmente, os vendedores oferecem uma variedade de mercadorias novas, usadas, remodeladas e colecionáveis on-line (cartão não presente) ou em lojas (cartão-presente). Você pode vincular seus cartões de crédito, cartões de débito, vouchers, contas bancárias e fazer transferências, transações (ou seja, débitos), reembolsos e muito mais...

A Zoop deve cumprir certos requisitos antes de ativar um vendedor para receber cartões de crédito / débito e receber pagamentos. Para ser compatível, a Zoop deve executar o KYC ou "conhecer o seu cliente" em um destinatário antes de permitir o processamento do cartão de crédito em um ambiente de produção e os fundos serem enviados para uma conta bancária.
Então, colete toda a informação que puder!

O objeto vendedor

Atributos

id

string

Identificador exclusivo para este vendedor

resource

string Value: seller

taxpayer_id

string

Um número de identificação do contribuinte é usado para registrar e acompanhar os pagamentos de impostos.

type

enum (individual, business)

description

string

Uma string arbitrária que você pode anexar a um recurso de vendedor

first_name

string

Contém o primeiro nome do vendedor

last_name

string

Contém o sobrenome do vendedor

email

string

Endereço de e-mail deste vendedor

phone_number

string

Formatação do número E.164 para o telefone do vendedor. Os números E.164 podem ter um máximo de quinze dígitos e geralmente são escritos da seguinte forma: [+] [código do país] [número do assinante, incluindo o código de área].

mcc

integer

Um código de 4 dígitos designado por uma empresa de cartão de crédito que lista o produto, serviço ou linha de negócios de um comerciante.

birthdate

string

Data de nascimento do vendedor individual ou representante do negócio. O formato é AAAA-MM, e. "1980-05"

facebook

string

ID do Facebook ou nome de usuário do vendedor ou representante do negócio.

twitter

string

ID do Twitter ou nome de usuário do vendedor ou representante do negócio

ein

String
CNPJ do Vendendor

address

object

linha1

string

Endereço da pessoa.

linha2

string

O número da rua permite que você identifique cada edifício em uma rua.

linha3
string

Número do apartamento e outras informações.

Vizinhança

string

Um distrito, especialmente um que forma uma comunidade dentro de uma cidade ou cidade.

cidade

string

Cidade do vendedor individual.

Estado

string

Código ISO 3166-2 para o estado da pessoa

Código postal

string

Código postal da pessoa

Código do país

string

ISO 3166-1 alpha-2 - códigos de país de duas letras. Valor padrão: EUA

localização da latitude

float

A latitude do endereço do indivíduo

localização da longitude

float

A longitude do endereço do indivíduo

default_debit

string

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

string

O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária

is_mobile

boolean

Seja ou não o negócio móvel.

show_profile_online

boolean

Pode publicar sua página para tornar a informação comercial visível aos clientes on-line.

metadata

optional {"key": "value"} or null

Mapeamento de chaves de string para valores de sequência de caracteres. key (Chave) é o identificador para os metadados (máximo de 30 caracteres). value (valor) é a informação a ser armazenada como metadados.

created_at

string

W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ)

updated_at

string

W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ)

Status de vendedor

new (Novo) - O vendedor foi criado pelo aplicativo.
pending (Pendente) - As informações do vendedor foram recebidas com sucesso para processamento / subscrição.
enabled (Habilitado) - As informações do vendedor foram verificadas e validadas com sucesso. Foi concedida uma aprovação temporária e o vendedor pode realizar transações de cartões de crédito / débito por um período de tempo limitado, até que o processo de subscrição seja concluído. Sem aviso prévio, o pedido pode ser negado mais tarde.
activo (Ativo) - O cadastro do vendedor no Zoop está completo.
deleted (Excluído) - O cadastro do vendedor foi excluído.
expired (Expirou) - O Vendedor irá expirar se ainda estiverem em estado "novo" após 30 minutos.

Criar documento de cadastro de vendedor

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

ID do vendedor

Form Data

file
file
required

Documento que será cadastrado

category
string
required

Categoria do documento cadastrado

metadata
string

Metadados associados ao documento

description
string

Descrição do documento

Response

Documento criado com sucesso

idstring
namestring
statusstring
pathstring
extensionstring
mime_typestring
sizeinteger
md5string
descriptionstring
categorystring
uploaded_byobject
uploaded_by.idstring
uploaded_by.resourcestring
uploaded_by.typestring
uploaded_ipstring
metadataobject

Marketplace/Vendedor/Documento não encontrado

Listar documentos de um vendedor

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/documents"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

ID do vendedor

Query Params

limit
int32

Limita o número de objetos retornados, podendo ser entre 1 e 100

sort
string

Determinar como ordenar a lista em relação a data de criação do objeto

offset
int32

Determina o ponto de inicio dos registros retornados

date_range
number

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

date_range[gt]
number

Retorna valores onde a data maior que o timestamp informado

date_range[gte]
number

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]
number

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]
number

Retorna valores onde a data for menor ou igual que o timestamp informado

Response

Documentos recuperados com sucesso

resourcestring
uristring
limitnumber
offsetnumber
has_moreboolean
query_countnumber
totalnumber
itemsarray

Marketplace/Vendedor não encontrado

Atualiza os dados de um documento de um vendedor

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/documents/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

id
string
required

ID do documento

Body Params

id
string
name
string
status
string
path
string
extension
string
mime_type
string
size
integer
md5
string
description
string
category
string
uploaded_by
object
 
uploaded_by.id
string
uploaded_by.resource
string
uploaded_by.type
string
uploaded_ip
string
metadata
object
 

Response

Documento alterado com sucesso

idstring
namestring
statusstring
pathstring
extensionstring
mime_typestring
sizeinteger
md5string
descriptionstring
categorystring
uploaded_byobject
uploaded_by.idstring
uploaded_by.resourcestring
uploaded_by.typestring
uploaded_ipstring
metadataobject

Marketplace/Documento não encontrado

Listar MCCs (Merchant Category Codes)

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/merchant_category_codes
curl --request GET \
  --url https://api.zoop.ws/v1/merchant_category_codes
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/merchant_category_codes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/merchant_category_codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/merchant_category_codes");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/merchant_category_codes"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Operação realizada com sucesso

Criar novo vendedor do tipo indivíduo

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Body Params

id
string
status
string
resource
string
type
string
account_balance
number
current_balance
number
fiscal_responsibility
string

ID de vendedor responsável por receber os créditos pelas vendas

first_name
string
last_name
string
email
string
phone_number
string
taxpayer_id
string
birthdate
string
statement_descriptor
string
description
string
address
object
 
address.line1
string
address.line2
string
address.line3
string
address.neighborhood
string
address.city
string
address.state
string
address.postal_code
string
address.country_code
string
delinquent
boolean
default_debit
string

cartão default para compras

default_credit
string

conta bancaria default para depositios

mcc
string

MCC ID

metadata
object
 
created_at
dateTime
updated_at
dateTime

Response

Vendedor cadastrado com sucesso

idstring
statusstring
resourcestring
typestring
account_balancenumber
current_balancenumber
fiscal_responsibilitystring

ID de vendedor responsável por receber os créditos pelas vendas

first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
statement_descriptorstring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

mccstring

MCC ID

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace não encontrado

Alterar um vendedor do tipo indivíduo

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/individuals/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

id
string
required

ID do documento

Body Params

id
string
status
string
resource
string
type
string
account_balance
number
current_balance
number
fiscal_responsibility
string

ID de vendedor responsável por receber os créditos pelas vendas

first_name
string
last_name
string
email
string
phone_number
string
taxpayer_id
string
birthdate
string
statement_descriptor
string
description
string
address
object
 
address.line1
string
address.line2
string
address.line3
string
address.neighborhood
string
address.city
string
address.state
string
address.postal_code
string
address.country_code
string
delinquent
boolean
default_debit
string

cartão default para compras

default_credit
string

conta bancaria default para depositios

mcc
string

MCC ID

metadata
object
 
created_at
dateTime
updated_at
dateTime

Response

Vendedor alterado com sucesso

idstring
statusstring
resourcestring
typestring
account_balancenumber
current_balancenumber
fiscal_responsibilitystring

ID de vendedor responsável por receber os créditos pelas vendas

first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
statement_descriptorstring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

mccstring

MCC ID

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace não encontrado

Criar novo vendedor do tipo empresa

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Body Params

id
string

Identificador exclusivo para este vendedor

status
string
resource
string
type
string
account_balance
number
current_balance
number
fiscal_responsibility
string

ID de vendedor responsável por receber os créditos pelas vendas

owner
object
 
owner.first_name
string
owner.last_name
string
owner.email
string
owner.phone_number
string
owner.taxpayer_id
string
owner.birthdate
string
description
string
business_name
string
business_phone
string
business_email
string
business_website
string
business_description
string
business_facebook
string
business_twitter
string
ein
string
statement_descriptor
string
business_address
object
 
business_address.line1
string
business_address.line2
string
business_address.line3
string
business_address.neighborhood
string
business_address.city
string
business_address.state
string

Código ISO 3166-2 para o estado

business_address.postal_code
string
business_address.country_code
string

ISO 3166-1 alpha-2 - códigos de país de duas letras.

business_opening_date
date
owner_address
object
 
owner_address.line1
string
owner_address.line2
string
owner_address.line3
string
owner_address.neighborhood
string
owner_address.city
string
owner_address.state
string
owner_address.postal_code
string
owner_address.country_code
string
delinquent
boolean
default_debit
string

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
string

O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária

mcc
string

MCC ID

metadata
object
 
created_at
dateTime
updated_at
dateTime

Response

Vendedor cadastrado com sucesso

idstring

Identificador exclusivo para este vendedor

statusstring
resourcestring
typestring
account_balancenumber
current_balancenumber
fiscal_responsibilitystring

ID de vendedor responsável por receber os créditos pelas vendas

ownerobject
owner.first_namestring
owner.last_namestring
owner.emailstring
owner.phone_numberstring
owner.taxpayer_idstring
owner.birthdatestring
descriptionstring
business_namestring
business_phonestring
business_emailstring
business_websitestring
business_descriptionstring
business_facebookstring
business_twitterstring
einstring
statement_descriptorstring
business_addressobject
business_address.line1string
business_address.line2string
business_address.line3string
business_address.neighborhoodstring
business_address.citystring
business_address.statestring

Código ISO 3166-2 para o estado

business_address.postal_codestring
business_address.country_codestring

ISO 3166-1 alpha-2 - códigos de país de duas letras.

business_opening_datestring
owner_addressobject
owner_address.line1string
owner_address.line2string
owner_address.line3string
owner_address.neighborhoodstring
owner_address.citystring
owner_address.statestring
owner_address.postal_codestring
owner_address.country_codestring
delinquentboolean
default_debitstring

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_creditstring

O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária

mccstring

MCC ID

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace não encontrado

Alterar um vendedor do tipo empresa

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/businesses/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

id
string
required

ID do documento

Body Params

id
string

Identificador exclusivo para este vendedor

status
string
resource
string
type
string
account_balance
number
current_balance
number
fiscal_responsibility
string

ID de vendedor responsável por receber os créditos pelas vendas

owner
object
 
owner.first_name
string
owner.last_name
string
owner.email
string
owner.phone_number
string
owner.taxpayer_id
string
owner.birthdate
string
description
string
business_name
string
business_phone
string
business_email
string
business_website
string
business_description
string
business_facebook
string
business_twitter
string
ein
string
statement_descriptor
string
business_address
object
 
business_address.line1
string
business_address.line2
string
business_address.line3
string
business_address.neighborhood
string
business_address.city
string
business_address.state
string

Código ISO 3166-2 para o estado

business_address.postal_code
string
business_address.country_code
string

ISO 3166-1 alpha-2 - códigos de país de duas letras.

business_opening_date
date
owner_address
object
 
owner_address.line1
string
owner_address.line2
string
owner_address.line3
string
owner_address.neighborhood
string
owner_address.city
string
owner_address.state
string
owner_address.postal_code
string
owner_address.country_code
string
delinquent
boolean
default_debit
string

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
string

O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária

mcc
string

MCC ID

metadata
object
 
created_at
dateTime
updated_at
dateTime

Response

Vendedor alterado com sucesso

idstring

Identificador exclusivo para este vendedor

statusstring
resourcestring
typestring
account_balancenumber
current_balancenumber
fiscal_responsibilitystring

ID de vendedor responsável por receber os créditos pelas vendas

ownerobject
owner.first_namestring
owner.last_namestring
owner.emailstring
owner.phone_numberstring
owner.taxpayer_idstring
owner.birthdatestring
descriptionstring
business_namestring
business_phonestring
business_emailstring
business_websitestring
business_descriptionstring
business_facebookstring
business_twitterstring
einstring
statement_descriptorstring
business_addressobject
business_address.line1string
business_address.line2string
business_address.line3string
business_address.neighborhoodstring
business_address.citystring
business_address.statestring

Código ISO 3166-2 para o estado

business_address.postal_codestring
business_address.country_codestring

ISO 3166-1 alpha-2 - códigos de país de duas letras.

business_opening_datestring
owner_addressobject
owner_address.line1string
owner_address.line2string
owner_address.line3string
owner_address.neighborhoodstring
owner_address.citystring
owner_address.statestring
owner_address.postal_codestring
owner_address.country_codestring
delinquentboolean
default_debitstring

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_creditstring

O banco bancário padrão associado a um vendedor que será usado para enviar dinheiro (crédito) a conta bancária

mccstring

MCC ID

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace/Vendedor não encontrado

Recupera detalhes de vendedor pelo id

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

id
string
required

ID do vendedor do tipo individuo ou empresa

Response

Vendedor recuperado com sucesso

idstring
statusstring
resourcestring
typestring
account_balancenumber
current_balancenumber
fiscal_responsibilitystring

ID de vendedor responsável por receber os créditos pelas vendas

first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
statement_descriptorstring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

mccstring

MCC ID

metadataobject
created_atstring
updated_atstring

Marketplace/Vendedor não encontrado

Deleta um de vendedor pelo id

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id
curl --request DELETE \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

id
string
required

ID do vendedor do tipo individuo ou empresa

Response

Vendedor deletado com sucesso

Marketplace/Vendedor não encontrado

Listando vendedores

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Query Params

limit
int32

Limita o número de objetos retornados, podendo ser entre 1 e 100

sort
string

Determinar como ordenar a lista em relação a data de criação do objeto

offset
int32

Determina o ponto de inicio dos registros retornados

date_range
number

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

date_range[gt]
number

Retorna valores onde a data maior que o timestamp informado

date_range[gte]
number

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]
number

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]
number

Retorna valores onde a data for menor ou igual que o timestamp informado

Response

Vendedor recuperado com sucesso

resourcestring
uristring
limitnumber
offsetnumber
has_moreboolean
query_countnumber
totalnumber
itemsarray

Marketplace/Vendedor não encontrado

Comprador

 

Os clientes da Zoop podem ter duas funções: o comprador (usuários que podem ser debitados) e a função do vendedor (usuários que podem ser creditados). Nesta sessão, vamos falar um pouco mais sobre o objeto "comprador" ou "buyer".

O objeto comprador (buyer) é usado para editar, excluir e atualizar os compradores, bem como para permitir reembolsos, assinaturas, inserir detalhes do cartão de crédito para um comprador, editar detalhes e, claro, fazer transações.

Você pode buscar apenas um comprador, bem como uma lista de todos os compradores do seu marketplace.

O objeto Comprador

Atributos

id

string

Identificador único do comprador

resource

string

Valor: buyer

description

string

Campo livre contendo a descrição do comprador

first_name

string

primeiro nome do comprador

last_name

string

último nome do comprador

taxpayer_id

string

CPF ou CNPJ do comprador

email

string

Endereço de email do comprador

phone_number

Número do telefone do comprador no formato E.164. Os números E.164 podem ter um máximo de quinze dígitos e geralmente são escritos da seguinte forma: [+] [código do país] [número do assinante, incluindo o código de área].

birthdate

string

Data de nascimento do comprador no formato YYYY-mm-dd

facebook

string

Facebook ID do comprador

twitter

string

Twitter ID do comprador

email_optin

boolean

Indica se o comprador gostaria ou não de receber emails. Valor padrão: false

sms_optin

boolean

Indica se o comprador gostaria ou não de receber SMSs. Valor padrão: false

default_receipt_delivery_method

enum (sms, email)

Método padrão para o envio de recibos de compras (email ou SMS).

address

objeto "address"

O mesmo objeto utilizado no campo de endereço do vendedor.

payment_methods

list

Objeto "card" ou "bankaccount"

default_debit

string

Método padrão para pagamento atribuído ao comprador que será utilizado para debitar da conta ou do cartão de débito.

default_credit

string

Método padrão para pagamento atribuído ao comprador que será utilizado para debitar da conta ou do cartão de crédito.

metadata

optional {"key": "value"} or null

Mapeamento de keys de string e values de caracteres. Key é o identificador para os metadados (máximo de 30 caracteres). Value é a informação a ser armazenada como metadado.

created_at

string

Data de criação do comprador no formato (yyyy-mm-ddThh:mm:ssZ)

updated_at

string

Data da última atualização do comprador no formato (yyyy-mm-ddThh:mm:ssZ)

Criar comprador

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

Body Params

first_name
string
last_name
string
email
string
phone_number
string
taxpayer_id
string
birthdate
string
description
string
address
object
 
address.line1
string
address.line2
string
address.line3
string
address.neighborhood
string
address.city
string
address.state
string
address.postal_code
string
address.country_code
string

Response

Comprador criado com sucesso

idstring
statusstring
resourcestring
account_balancenumber
current_balancenumber
first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace não encontrado

Listar comprador por marketplace

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

Response

Comprador encontrado

Marketplace não encontrado

Alterar detalhes de comprador

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

buyer_id
string
required

identificador do buyer

Response

Comprador alterado com sucesso

idstring
statusstring
resourcestring
account_balancenumber
current_balancenumber
first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

metadataobject
created_atstring
updated_atstring

Missing required param

Marketplace/Buyer não encontrado

Recuperar detalhes de comprador

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

buyer_id
string
required

identificador do buyer

Response

Comprador alterado com sucesso

idstring
statusstring
resourcestring
account_balancenumber
current_balancenumber
first_namestring
last_namestring
emailstring
phone_numberstring
taxpayer_idstring
birthdatestring
descriptionstring
addressobject
address.line1string
address.line2string
address.line3string
address.neighborhoodstring
address.citystring
address.statestring
address.postal_codestring
address.country_codestring
delinquentboolean
default_debitstring

cartão default para compras

default_creditstring

conta bancaria default para depositios

metadataobject
created_atstring
updated_atstring

Marketplace/Buyer não encontrado

Remover comprador pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
curl --request DELETE \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

buyer_id
string
required

identificador do buyer

Response

Comprador removido com sucesso

Marketplace/Buyer não encontrado

Saldo de Conta

 

Recuperar saldo de conta por seller

Recupera o saldo corrente e saldo total de conta

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

seller_id
string
required

identificador do seller

Response

Saldo recuperado com sucesso

Marketplace/Seller não encontrado

Lista contas por seller

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/all"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

seller_id
string
required

identificador do seller

Response

Saldo recuperado com sucesso

Marketplace/Seller não encontrado

Lista contas por buyer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

buyer_id
string
required

identificador do comprador

Response

Saldo recuperado com sucesso

Marketplace/Buyer não encontrado

Listar histórico de lançamentos pelo identificador da conta

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/balances/balance_id/history"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

balance_id
string
required

identificador da conta

Response

Histórico recuperado com sucesso

Marketplace/Saldo não encontrado

Listar histórico de lançamentos de conta por seller

Listagem de histórico da conta principal do seller

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/balances/history"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

seller_id
string
required

identificador do seller

Response

Histórico recuperado com sucesso

Marketplace/Seller não encontrado

Listar histórico de lançamentos de conta por buyer

Listagem de histórico da conta principal do buyer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/buyers/buyer_id/balances/history"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

buyer_id
string
required

identificador do comprador

Response

Histórico recuperado com sucesso

Marketplace/Seller não encontrado

Token

 

A Zoop possui a funcionalidade de tokenização, que é o ato de usar um valor substituto, ou 'token' que não tem valor inerente, no lugar dos dados que tem valor. Desta forma, você poderá realizar cobranças em um cartão de crédito, debitar uma conta bancária ou mesmo transferir pagamentos para contas bancárias sem ter que armazenar informações confidenciais em seus próprios servidores ou ter que pedir aos seus clientes que digitem as informações de cartões todas as vezes.

Os tokens devem ser usados apenas uma vez. Para armazená-lo pra uso posterior, você precisará criar um objeto comprador (buyer) ou vendedor (seller) - pessoa física ou jurídica.

O objeto token

Atributos

id

string

Identificador único para este objeto

resource

string Valor: token

type

enum ( card, bankaccount)

O tipo do token

used

boolean

Indica se o token foi ou não utilizado. tokens podem ser utilizados apenas 1 vez.
Valor padrão: true

created_at

string

Data de criação do token no formato (yyyy-mm-ddThh:mm:ssZ)

updated_at

string

Data da última atualização no formato (yyyy-mm-ddThh:mm:ssZ)

Criar novo token de cartão

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/tokens"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

Body Params

holder_name
string

Nome do portador

expiration_month
string

mês de expiração do cartão (MM)

expiration_year
string

ano de expiração do cartão (AAAA)

card_number
string

Número do cartão

security_code
string

Código de segurança do cartão (CVC)

Response

Token de cartão criado com sucesso

Requisição/Parâmetros invalidos

Marketplace/ não encontrado

Criar novo token de conta bancária

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/bank_accounts/tokens"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

Body Params

holder_name
string

Nome do portador

bank_code
number

Bank Account

routing_number
number

Agencia sem DV (4 digitos)

account_number
number

Conta Bancaria com DV

taxpayer_id
string

CPF, caso seller seja PF

ein
string

CNPJ, caso seller seja PJ

type
string

Conta corrente ou poupança

Response

Token de cartão criado com sucesso

Requisição/Parâmetros invalidos

Marketplace não encontrado

Recuperar detalhes de token de cartão/conta bancária

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/tokens/token_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

identificador do marketplace

token_id
string
required

identificador do token

Response

Token recuperado com sucesso

Marketplace/Token não encontrado

Transação

 

Quando um cliente fornece um número de cartão, mas não tem acesso ao cartão físico, a compra é conhecida como uma transação de cartão não presente (CNP). Esse tipo de transação geralmente ocorre através da Internet ou através de um call center.

O recurso de transações é usado para debitar um cartão ou uma conta bancária eletronicamente via ACH. Ele retorna um identificador exclusivo que pode ser posteriormente usado para emitir um reembolso integral ou parcial. Você precisará de um ID de cliente existente (vendedor ou comprador) ou de um método de pagamento válido (cartão ou conta bancária). Tanto o cartão como a conta bancária devem ser um token não usado ou um ID exclusivo existente já associado a um cliente. Alternativamente, você também pode usar um ID de pré-autorização.

O recurso da transação

Atributos

id

string
Identificador exclusivo para esta transação

resource

string
Value: transaction

status

enum (new, pending, pre_authorized, succeeded, failed, reversed, canceled, refunded, dispute, charged_back)

Indica o estado atual desta transação, por exemplo, reembolsado significa que o valor é totalmente reembolsado.

amount

integer > 0
Um número inteiro positivo em centavos que representa o quanto de carga, p. "1260" por US $ 12,60.

original_amount

integer > 0

Um número inteiro positivo em centavos

currency

string
Um código de moeda com formato ISO 4217 de 3 letras

description

string
Uma seqüência arbitrária que você pode anexar a um objeto de transação

payment_type

enum (debit, credit, boleto, bank_account)

Métodos de pagamento aceitos. Os métodos de pagamento disponíveis podem variar de acordo com a localização.

transaction_number

string
Este é o número da transação que aparece nos recibos de e-mail enviados para esta venda.

refunds

list
refund objects or null

rewards

list
Um identificador exclusivo para o objeto de recompensas associado.

discounts

string
Um identificador exclusivo para o objeto de desconto associado.

sales_receipt

string
Um identificador exclusivo para o objeto de recebimento associado.

on_behalf_of

string
Um identificador exclusivo de um objeto vendedor. Tanto os vendedores individuais ou comerciais dentro do seu mercado.

customer

string
Um identificador exclusivo de um vendedor ou um objeto comprador. Os clientes representam vendedores (indivíduos ou empresas) ou compradores dentro do mercado.

statement_descriptor

string
Um descritor de declaração é o nome da empresa que aparece no extrato mensal do cartão de crédito do cliente. Permite que o cliente identifique rapidamente as transações reduzindo disputas e atendimento ao cliente.

payment_method
object

Um método de pagamento válido (cartão ou conta bancária).

installment_plan

object
O plano permite aos compradores comprar produtos em até 12 parcelas em qualquer cartão de crédito, com ou sem taxas de juros.

mode

enum (interest_free, with_interest)
Indica o tipo de plano de parcelamento. Para os planos de juros, o montante do pagamento será dividido em parcelas mensais. O vendedor recebe o pagamento no mesmo número de parcelas. Para com os planos de interesse, o interesse é aplicado ao preço de compra, o montante será dividido em parcelas mensais e pago pelo comprador. O vendedor recebe o valor total de uma só vez, a partir de uma transação de cartão de crédito / débito.

number_installments

integer
O número de parcelas é organizado com o comprador no momento da compra.

fees

integer > 0
Um número inteiro positivo em centavos que representa a taxa total aplicada à transação.

fee_details

object

currency

string

A 3-letter ISO 4217 formatted currency code

location_latitute

float

A latitude em que ocorreu a transação

location_longitude

float

A longitude em que ocorreu a transação

metadata

optional {"key": "value"} or null

Mapeamento de chaves de string para valores de seqüência de caracteres. Chave é o identificador para os metadados (máximo de 30 caracteres). O valor é a informação a ser armazenada como metadados.

expected_on

string

W3C Datetime Format (yyyy-mm-ddThh:mm:ssZ)

Retornar ao criar a transação como uma estimativa para quando o dinheiro estará disponível.

created_at

string

W3C Datetime Format para a criação de data (yyyy-mm-ddThh:mm:ssZ)

updated_at

string

W3C Datetime Format Para a última atualização (yyyy-mm-ddThh:mm:ssZ)

Status da Transação

  • Novo (new) - A transação foi criada pelo aplicativo.
  • Pendente (pending) - As informações da transação foram recebidas com sucesso para processamento.
  • Pré-autorizado ( pre_authorized) - Quando as Transações são emitidas com o parâmetro de captura como falso, uma pré-autorização é criada e precisará ser capturada mais tarde. Uma transação pré-autorizada deve ser capturada dentro de sete dias ou será automaticamente expirada.
  • Sucesso (succeeded) - O pagamento foi autorizado e os fundos estarão disponíveis em depósito.
  • Falhou (failed) - A transação falhou.
  • Invertido (reversed) - Uma reversão ocorre antes que a transação tenha sido confirmada.
  • Cancelado (canceled) - O pagamento foi cancelado / anulado pelo vendedor ou pelo aplicativo. As taxas cobradas originalmente também são anuladas.
  • Reembolsado (refunded) - A diferença entre um vazio e um reembolso se resume a se uma transação foi ou não resolvida. Uma transação instável pode ser anulada. Uma vez que uma transação foi resolvida, ela só pode ser reembolsada.
  • Disputa (dispute) - Quando o titular do cartão envia uma queixa comunicando-se com o banco emissor sobre a transação errada, o banco emissor abre uma disputa com o comerciante, solicitando a documentação necessária e a prova para remediar o estorno. Se a documentação fornecida for satisfatória, a disputa é simplesmente recusada e o cliente é cobrado com uma taxa de processamento. Se os documentos parecem ser insatisfatórios, o montante do reembolso será fornecido ao cliente e o comerciante será debitado.
  • charged_back - O status indica que o pagamento foi cobrado pelo comprador e o pagamento foi debitado da conta do vendedor.

Fluxo de notificação de Charged Back

  1. O comprador solicita ao seu banco emissor o estorno / cancelamento de uma transação;
  2. O emissor informa à Zoop que esta transação foi contestada pelo comprador;
  3. A Zoop atualiza o status da transação para "dispute" e suspende os pagamentos de recebíveis a vencer associados a esta venda;
  4. A notificação sobre transações em disputa é realizada automaticamente pelo sistema através do disparo do evento de "transaction.disputed" devendo este evento ser monitorado pelo marketplace para a que possa atuar caso desejado;
  5. Caso o EC ou o Marketplace envie a documentação necessária no prazo de 7 dias (corridos) a Zoop encaminha a documentação ao adquirente / emissor e aguarda o resultado do processo, que pode ocorrer no prazo de até 30 dias (corridos);
  6. Caso o retorno seja favorável ao EC, a Zoop é notificada, confirma o processo de disputa e dispara o evento "transaction.dispute.succeeded", alterando o status da transação para 'succeeded' e removendo a suspensão dos recebíeis pendentes de pagamento;
  7. Caso o retorno seja favorável ao comprador, ou a Zoop não receba retorno no prazo estipulado, o processo de disputa é encerrado e o status da transação é alterado em definitivo para "charged_back", sendo disparado o evento "transaction.charged_back" e realizado o debito na conta do EC ou do Marketplace, dependendo de quem for o responsável pelos chargebacks no contrato comercial
  8. Caso o Marketplace / EC não envie a documentação dentro do prazo, o processo de disputa é encerrado e o status da transação é atualizado em definitivo para "transaction.charged_back"

Listar transaçoes do marketplace

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Query Params

limit
int32

Limita o número de objetos retornados, podendo ser entre 1 e 100

sort
string

Determinar como ordenar a lista em relação a data de criação do objeto

offset
int32

Determina o ponto de inicio dos registros retornados

date_range
number

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

date_range[gt]
number

Retorna valores onde a data maior que o timestamp informado

date_range[gte]
number

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]
number

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]
number

Retorna valores onde a data for menor ou igual que o timestamp informado

reference_id
string

Retorna transações onde o reference id for igual o informado

status
string

Retorna transações onde o status for igual o informado. Para busca múltipla basta concatenar com ,

payment_type
string

Retorna transações onde o payment type for igual o informado. Para busca múltipla basta concatenar com ,

Response

Transações recuperadas com sucesso

resourcestring
uristring
limitnumber
offsetnumber
has_moreboolean
query_countnumber
totalnumber
itemsobject
items.idstring
items.statusstring
items.resourcestring
items.amountstring
items.original_amountstring
items.currencystring
items.descriptionstring
items.payment_type
items.transaction_numberstring
items.sales_receiptstring
items.on_behalf_ofstring
items.statement_descriptorstring
items.payment_methodobject
items.payment_method.idstring
items.payment_method.resourcestring
items.payment_method.descriptionstring
items.payment_method.card_brandstring
items.payment_method.first4_digitsstring
items.payment_method.last4_digitsstring
items.payment_method.expiration_monthstring
items.payment_method.expiration_yearstring
items.payment_method.holder_namestring
items.payment_method.is_activeboolean
items.payment_method.is_validboolean
items.payment_method.is_verifiedboolean
items.payment_method.customerstring
items.payment_method.fingerprintstring
items.payment_method.uristring
items.payment_method.metadataobject
items.payment_method.created_atstring
items.payment_method.updated_atstring
items.point_of_saleobject
items.point_of_sale.entry_modestring
items.point_of_sale.identification_numberstring
items.refundedboolean
items.voidedboolean
items.capturedboolean
items.feesstring
items.fee_detailsobject
items.fee_details.amountstring
items.fee_details.prepaidboolean
items.fee_details.currencystring
items.fee_details.typestring
items.fee_details.descriptionstring
items.uristring
items.metadataobject
items.expected_onstring
items.created_atstring
items.updated_atstring

Marketplace não encontrado

Criar transação Cartão Não Presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Body Params

amount
integer
required

valor em centavos a ser cobrado pela transação

currency
string
required
description
string
required
payment_type
string
required
capture
boolean

Capturar transação (true) ou criar uma pre-autorização (false) para ser capturada a posteriori

on_behalf_of
string
required
reference_id
string

ID referência da sua aplicação VARCHAR(500)

payment_method
object
 
payment_method.expiration_date
string

Data de vencimento utilizado nas vendas por boleto

payment_method.top_instructions
array of strings

Instruções para o comprador utilizado nas vendas por boleto

source
object
 
source.usage
string
required
source.amount
integer

valor em centavos a ser cobrado na venda (opcional)

source.currency
string

moeda do valor a ser cobrado na venda

source.description
string

descrição da venda quando gerada (opcional)

source.type
string
required
source.capture
boolean

Capturar transação (true) ou criar uma pre-autorização (false) para ser capturada a posteriori

source.on_behalf_of
string
source.reference_id
string

ID referência da sua aplicação VARCHAR(500)

source.card
object

objeto obrigatório no tipo card e card_and_wallet

 
source.card.id
string

identificador do cartão para source tipo card

source.card.amount
integer

valor a ser cobrado neste cartao (opcional)

source.card.holder_name
string
source.card.expiration_month
string

mês de expiração do cartão (MM)

source.card.expiration_year
string

ano de expiração do cartão (AAAA)

source.card.card_number
string

Número do cartão

source.card.security_code
string

Código de segurança do cartão (CVC)

source.installment_plan
object
 
source.installment_plan.mode
string

modo de parcelamento, com juros no emissor (with_interest), ou sem juros (interest_free), com o custo já calculado no valor da transação.

source.installment_plan.number_installments
integer

número de parcelas (1-10)

source.statement_descriptor
string
source.customer
object

identificador do comprador que será cobrado

 
source.customer.id
string

identificador do comprador que será cobrado para source tipo customer, wallet e card_and_wallet

source.customer.amount
integer

valor a ser cobrado neste customer (opcional)

source.token
object

identificador do token de cartão que será cobrado obrigatorio no source tipo token

 
source.token.id
string

identificador do cartão para source tipo card

source.token.amount
integer

valor a ser cobrado neste token (opcional)

source.metadata
object
 
installment_plan
object
 
installment_plan.mode
string

modo de parcelamento, com juros no emissor (with_interest), ou sem juros (interest_free), com o custo já calculado no valor da transação.

installment_plan.number_installments
integer

número de parcelas (1-10)

statement_descriptor
string
customer
string

identificador do comprador que será cobrado

token
string

identificador do token de cartão que será cobrado

metadata
object
 

Response

Transação criada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Transação não encontrada

Listar transaçoes por vendedor

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sellers/seller_id/transactions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

identificador do seller

Query Params

limit
int32

Limita o número de objetos retornados, podendo ser entre 1 e 100

sort
string

Determinar como ordenar a lista em relação a data de criação do objeto

offset
int32

Determina o ponto de inicio dos registros retornados

date_range
number

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

date_range[gt]
number

Retorna valores onde a data maior que o timestamp informado

date_range[gte]
number

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]
number

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]
number

Retorna valores onde a data for menor ou igual que o timestamp informado

Response

Transações recuperadas com sucesso

resourcestring
uristring
limitnumber
offsetnumber
has_moreboolean
query_countnumber
totalnumber
itemsobject
items.idstring
items.statusstring
items.resourcestring
items.amountstring
items.original_amountstring
items.currencystring
items.descriptionstring
items.payment_type
items.transaction_numberstring
items.sales_receiptstring
items.on_behalf_ofstring
items.statement_descriptorstring
items.payment_methodobject
items.payment_method.idstring
items.payment_method.resourcestring
items.payment_method.descriptionstring
items.payment_method.card_brandstring
items.payment_method.first4_digitsstring
items.payment_method.last4_digitsstring
items.payment_method.expiration_monthstring
items.payment_method.expiration_yearstring
items.payment_method.holder_namestring
items.payment_method.is_activeboolean
items.payment_method.is_validboolean
items.payment_method.is_verifiedboolean
items.payment_method.customerstring
items.payment_method.fingerprintstring
items.payment_method.uristring
items.payment_method.metadataobject
items.payment_method.created_atstring
items.payment_method.updated_atstring
items.point_of_saleobject
items.point_of_sale.entry_modestring
items.point_of_sale.identification_numberstring
items.refundedboolean
items.voidedboolean
items.capturedboolean
items.feesstring
items.fee_detailsobject
items.fee_details.amountstring
items.fee_details.prepaidboolean
items.fee_details.currencystring
items.fee_details.typestring
items.fee_details.descriptionstring
items.uristring
items.metadataobject
items.expected_onstring
items.created_atstring
items.updated_atstring

Marketplace não encontrado

Recuperar detalhes de transação pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador da transação

Response

Transação recuperada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Transação não encontrada

Alterar detalhes de transação pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador da transação

Body Params

description
string
metadata
object
 

Response

Transação alterada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Transação não encontrada

Estornar transação cartão não presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/void"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador da transação

Body Params

on_behalf_of
string
required

Identificador do seller responsável pela venda

amount
integer
required

valor da venda a ser estornado em centavos

Response

Transação estornada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Requisição/Parametros inválidos

Marketplace/Transação não encontrado

Capturar transação cartão não presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/transactions/transaction_id/capture"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador da transação

Body Params

on_behalf_of
string
required

Identificador do seller responsável pela venda

amount
integer
required

valor da venda a ser capturado em centavos. para captura parcial basta enviar valor a menor, sendo possível realizar somente uma captura parcial por autorização

Response

Transação capturada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Requisição/Parametros inválidos

Marketplace/Transação não encontrado

Cartão

 

O recurso do cartão representa um método de pagamento com cartão de crédito ou débito. Você só pode criar um novo cartão de crédito se tiver um token de cartão seguro. A Zoop usa tokenização para proteger cartões, contas bancárias e proteger outras informações confidenciais de identificação pessoal (PII), a fim de cumprir os padrões da indústria e os regulamentos governamentais.

O recurso do cartão

Atributos

id

string

Identificador exclusivo para este cartão

resource

string Value: card

description

string

An arbitrary string which you can attach to a card resource

first4_digits

string

The first four digits of the credit card

card_brand

string

Card brand. Can be Visa, American Express, MasterCard, Discover, JCB, Diners Club, or unknown

expiration_month

integer

Expiration month of the credit card

expiration_year

integer

Expiration year of the credit card

holder_name

string

Nome do vendedor (seller) ou comprador (buyer) a quem este cartão de crédito foi emitido.

customer

string

O identificador exclusivo de um vendedor (seller*) ou um recurso comprador (buyer**)

is_active

boolean

Indica se o cartão está ativo ( true ) ou foi desativado ( false ). Valor padrão: true

is_verified

boolean

Se um recurso de cartão foi ou não verificado durante o cartão, você não processou transações com cartões que falham neste check.ization (por exemplo, corresponde ao código de segurança). É fortemente recomendável

fingerprint

string

Todo cartão ( card) recurso tem um atributo de impressão digital que pode ser usado para identificar de forma exclusiva um número de cartão particular

verification_checklist

object

postal_code_check

string

Se o código postal foi fornecido, os resultados do cheque: pass, fail ou unchecked

security_code_check

string

Se um CVC fosse fornecido, os resultados do cheque:pass, fail, ou unchecked

address_line1_check

string

If address[line1] was provided, results of the check: pass, fail, ou unchecked

metadata

optional {"key": "value"} ou null

Mapeamento de chaves de string para valores de sequência de caracteres. key é o identificador para os metadados (máximo de 30 caracteres). value é a informação a ser armazenada como metadados.

created_at

string

W3C Datetime Format para a criação da data (yyyy-mm-ddThh:mm:ssZ)

updated_at

string

W3C Datetime Format para a última atualização (yyyy-mm-ddThh:mm:ssZ)

Associar cartão com comprador

Associar token de cartão com comprador

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/cards
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/cards
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/cards' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Body Params

token
string
required

Identificador do token de cartão a ser associado ao customer

customer
string
required

Identificador do customer

Response

Cartão associado com sucesso

Requisição/Parâmetros invalidos

Marketplace/ não encontrado

Recuperar detalhes de cartão pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

card_id
string
required

identificador do cartão

Response

Cartão recuperado com sucesso

Marketplace/Cartão não encontrado

Remover cartão pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
curl --request DELETE \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

card_id
string
required

identificador do cartão

Response

Cartão removido com sucesso

Marketplace/Cartão não encontrado

Atualizar detalhes de cartão pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
curl --request PUT \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/cards/card_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

card_id
string
required

identificador do cartão

Response

Cartão atualizado com sucesso

Marketplace/Cartão não encontrado

Source

 

Criar source para utilização transação

Um objeto source permite você aceitar uma variedade de formas de pagamento

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/marketplaces/marketplace_id/sources
curl --request POST \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sources
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sources' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

Body Params

usage
string
required
amount
integer

valor em centavos a ser cobrado na venda (opcional)

currency
string

moeda do valor a ser cobrado na venda

description
string

descrição da venda quando gerada (opcional)

type
string
required
capture
boolean

Capturar transação (true) ou criar uma pre-autorização (false) para ser capturada a posteriori

on_behalf_of
string
reference_id
string

ID referência da sua aplicação VARCHAR(500)

card
object

objeto obrigatório no tipo card e card_and_wallet

 
card.id
string

identificador do cartão para source tipo card

card.amount
integer

valor a ser cobrado neste cartao (opcional)

card.holder_name
string
card.expiration_month
string

mês de expiração do cartão (MM)

card.expiration_year
string

ano de expiração do cartão (AAAA)

card.card_number
string

Número do cartão

card.security_code
string

Código de segurança do cartão (CVC)

installment_plan
object
 
installment_plan.mode
string

modo de parcelamento, com juros no emissor (with_interest), ou sem juros (interest_free), com o custo já calculado no valor da transação.

installment_plan.number_installments
integer

número de parcelas (1-10)

statement_descriptor
string
customer
object

identificador do comprador que será cobrado

 
customer.id
string

identificador do comprador que será cobrado para source tipo customer, wallet e card_and_wallet

customer.amount
integer

valor a ser cobrado neste customer (opcional)

token
object

identificador do token de cartão que será cobrado obrigatorio no source tipo token

 
token.id
string

identificador do cartão para source tipo card

token.amount
integer

valor a ser cobrado neste token (opcional)

metadata
object
 

Response

Source criado com sucesso

idstring
statusstring
usagestring
amountstring

valor a ser cobrado na venda (opcional)

currencystring

moeda do valor a ser cobrado na venda (opcional)

descriptionstring

descrição da venda quando gerada (opcional)

typestring
captureboolean

Capturar transação (true) ou criar uma pre-autorização (false) para ser capturada a posteriori

on_behalf_ofstring
reference_idstring

ID referência da sua aplicação VARCHAR(500)

cardobject

objeto obrigatório no tipo card e card_and_wallet

card.idstring
card.amountstring

valor a ser cobrado na venda (opcional)

card.resourcestring
card.descriptionstring
card.card_brandstring
card.first4_digitsstring
card.last4_digitsstring
card.expiration_monthstring
card.expiration_yearstring
card.holder_namestring
card.is_activeboolean
card.is_validboolean
card.is_verifiedboolean
card.customerstring
card.fingerprintstring
card.uristring
card.metadataobject
card.created_atstring
card.updated_atstring
installment_planobject
installment_plan.modestring

modo de parcelamento, com juros no emissor (with_interest), ou sem juros (interest_free), com o custo já calculado no valor da transação.

installment_plan.number_installmentsinteger

número de parcelas (1-10)

statement_descriptorstring
customerobject

identificador do comprador que será cobrado

customer.idstring

identificador do comprador que será cobrado para source tipo customer, wallet e card_and_wallet

customer.amountinteger

valor a ser cobrado neste customer (opcional)

tokenobject

identificador do token de cartão que será cobrado obrigatorio no source tipo token

token.idstring

identificador do cartão para source tipo card

token.amountinteger

valor a ser cobrado neste token (opcional)

uristring
metadataobject
created_atstring
updated_atstring

Requisição/Parâmetros invalidos

Marketplace/ não encontrado

Recuperar detalhes de source pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id
curl --request GET \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

source_id
string
required

identificador do source

Response

Source recuperado com sucesso

idstring
statusstring
usagestring
amountstring

valor a ser cobrado na venda (opcional)

currencystring

moeda do valor a ser cobrado na venda (opcional)

descriptionstring

descrição da venda quando gerada (opcional)

typestring
captureboolean

Capturar transação (true) ou criar uma pre-autorização (false) para ser capturada a posteriori

on_behalf_ofstring
reference_idstring

ID referência da sua aplicação VARCHAR(500)

cardobject

objeto obrigatório no tipo card e card_and_wallet

card.idstring
card.amountstring

valor a ser cobrado na venda (opcional)

card.resourcestring
card.descriptionstring
card.card_brandstring
card.first4_digitsstring
card.last4_digitsstring
card.expiration_monthstring
card.expiration_yearstring
card.holder_namestring
card.is_activeboolean
card.is_validboolean
card.is_verifiedboolean
card.customerstring
card.fingerprintstring
card.uristring
card.metadataobject
card.created_atstring
card.updated_atstring
installment_planobject
installment_plan.modestring

modo de parcelamento, com juros no emissor (with_interest), ou sem juros (interest_free), com o custo já calculado no valor da transação.

installment_plan.number_installmentsinteger

número de parcelas (1-10)

statement_descriptorstring
customerobject

identificador do comprador que será cobrado

customer.idstring

identificador do comprador que será cobrado para source tipo customer, wallet e card_and_wallet

customer.amountinteger

valor a ser cobrado neste customer (opcional)

tokenobject

identificador do token de cartão que será cobrado obrigatorio no source tipo token

token.idstring

identificador do cartão para source tipo card

token.amountinteger

valor a ser cobrado neste token (opcional)

uristring
metadataobject
created_atstring
updated_atstring

Marketplace/Source não encontrado

Remover source pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id
curl --request DELETE \
  --url https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/marketplaces/marketplace_id/sources/source_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

source_id
string
required

identificador do source

Response

Source removido com sucesso

Marketplace/Source não encontrado

Transação Cartão Presente (CHIP&PIN)

 

Criar novo terminal

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/terminals
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/terminals
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/terminals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/terminals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/terminals");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/terminals"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Terminal cadastrado com sucesso

Missing required param

Alterar detalhes de terminal pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1/card-present/terminals/terminal_id
curl --request PUT \
  --url https://api.zoop.ws/v1/card-present/terminals/terminal_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1/card-present/terminals/terminal_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/terminals/terminal_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1/card-present/terminals/terminal_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/terminals/terminal_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

terminal_id
string
required

identificador do terminal

Response

Terminal alterado com sucesso

Missing required param

Terminal não encontrado

Recuperar detalhes de terminal pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.zoop.ws/v1/card-present/terminals/terminal_id
curl --request GET \
  --url https://api.zoop.ws/v1/card-present/terminals/terminal_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.zoop.ws/v1/card-present/terminals/terminal_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/terminals/terminal_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.zoop.ws/v1/card-present/terminals/terminal_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/terminals/terminal_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

terminal_id
string
required

identificador do terminal

Response

Terminal recuperado com sucesso

Terminal não encontrado

Remover terminal pelo identificador

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.zoop.ws/v1/card-present/terminals/terminal_id
curl --request DELETE \
  --url https://api.zoop.ws/v1/card-present/terminals/terminal_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.zoop.ws/v1/card-present/terminals/terminal_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/terminals/terminal_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.zoop.ws/v1/card-present/terminals/terminal_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/terminals/terminal_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

terminal_id
string
required

identificador do terminal

Response

Terminal removido com sucesso

Terminal não encontrado

Recuperar parâmetros de inicialização por terminal

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/terminals/terminal_id/logon
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/terminals/terminal_id/logon
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/terminals/terminal_id/logon' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/terminals/terminal_id/logon")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/terminals/terminal_id/logon");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/terminals/terminal_id/logon"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

terminal_id
string
required

terminal_id

Response

Terminal recuperado com sucesso

Terminal não encontrado

Criar transação cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

identificador do seller

Response

Transação criada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Missing required param

Marketplace/Seller não encontrado

Criar transação cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions
curl --request POST \
  --url https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/sellers/seller_id/transactions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

identificador do seller

Response

Transação criada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Missing required param

Marketplace/Seller não encontrado

Confirmar transação cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id
curl --request PUT \
  --url https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1.1/card-present/marketplaces/marketplace_id/transactions/transaction_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador da transação

Response

Transação confirmada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Missing required param

Marketplace/Seller não encontrado

Criar transação de pre-autorização cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/sellers/seller_id/preauthorizations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

seller_id
string
required

identificador do seller

Response

Transação de pre-autorização criada com sucesso

Missing required param

Marketplace/Seller não encontrado

Capturar transação de pre-autorização cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/capture"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador do transação de pre-autorização

Response

Transação capturada com sucesso

Missing required param

Marketplace/Transação não encontrado

Estornar transação cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/void"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador do transação

Response

Transação estornada com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Missing required param

Marketplace/Transação não encontrado

Estornar transação de pre-autorização cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/void"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador do transação de pre-autorização

Response

Transação de pre-autorização estornada com sucesso

Missing required param

Marketplace/Transação não encontrado

Desfazer transação de cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/transactions/transaction_id/reversals"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador do transação

Response

Transação desfeita com sucesso

idstring
statusstring
resourcestring
amountstring
original_amountstring
currencystring
descriptionstring
payment_type
transaction_numberstring
sales_receiptstring
on_behalf_ofstring
statement_descriptorstring
payment_methodobject
payment_method.idstring
payment_method.resourcestring
payment_method.descriptionstring
payment_method.card_brandstring
payment_method.first4_digitsstring
payment_method.last4_digitsstring
payment_method.expiration_monthstring
payment_method.expiration_yearstring
payment_method.holder_namestring
payment_method.is_activeboolean
payment_method.is_validboolean
payment_method.is_verifiedboolean
payment_method.customerstring
payment_method.fingerprintstring
payment_method.uristring
payment_method.metadataobject
payment_method.created_atstring
payment_method.updated_atstring
point_of_saleobject
point_of_sale.entry_modestring
point_of_sale.identification_numberstring
refundedboolean
voidedboolean
capturedboolean
feesstring
fee_detailsobject
fee_details.amountstring
fee_details.prepaidboolean
fee_details.currencystring
fee_details.typestring
fee_details.descriptionstring
uristring
metadataobject
expected_onstring
created_atstring
updated_atstring

Missing required param

Marketplace/Transação não encontrado

Desfazer transação de pre-autorização cartão presente

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals
curl --request POST \
  --url https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals");

xhr.send(data);
import requests

url = "https://api.zoop.ws/v1/card-present/marketplaces/marketplace_id/preauthorizations/transaction_id/reversals"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

marketplace_id
string
required

ID do marketplace

transaction_id
string
required

identificador do transação de pre-autorização

Response

Transação de pre-autorização desfeita com sucesso

Missing required param

Marketplace/Transação não encontrado

Recuperar parâmetros de inicialização por terminal

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.zoop.ws/v2/card-present/terminals/terminal_id/logon
curl --request POST \
  --url https://api.zoop.ws/v2/card-present/terminals/terminal_id/logon
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.zoop.ws/v2/card-present/terminals/terminal_id/logon' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.zoop.ws/v2/card-present/terminals/terminal_id/logon")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data