As APIs de Cobrança Pagamentos Digitais da Zoop permitem que você realize diferentes tipos de cobrança em nome dos vendedores do seu marketplace.

Com os dados de cartão tokenizados de maneira segura e associado à um comprador, você pode realizar uma cobrança do tipo card totalmente segura , ou então utilizar estes dados para realizar uma cobrança futuramente com o tipo customer.

Ainda de posse do identificador de um comprador criado, você pode realizar cobranças recorrentes, debitar diretamente a conta de pagamento do comprador através da cobrança tipo wallet, ou realizar cobranças do tipo boleto.

Por isso, vamos conhecer um pouco melhor as possibilidades de uma transação na Zoop.

Descrição geral de uma transação

Vamos descrever alguns do principais campos que você precisa conhecer de uma transação de Pagamentos Digitais.

Campos obrigatórios
amount - valor em centavos a ser cobrado pela transação
currency - moeda utilizada na transação (opcional na v2)
payment_type - tipo de pagamento que pode ser credit, wallet ou boleto (opcional na v2)

Campos opcionais
description - descrição da venda que é exibida na fatura
capture - define se a transação fará a cobrança nesse momento ou realizará uma pré-autorização.
payment_method - Conjunto de dados específicos para boleto
source - objeto que permite o envio dos dados do cartão diretamente na transação
installment_plan - objeto com informações referentes ao parcelamento
statement_descriptor - Nome do vendedor exibido na fatura do cartão
customer - Identificador de comprador que deverá ser cobrado
token - Identificador de token de cartão que deverá ser cobrado
metadata - Objeto que permite o armazenamento de dados adicionais.

Configuração dinâmica de statement descriptor

Por padrão o statement_descriptor (nome fantasia) configurado na conta do vendedor será exibido na fatura do comprador quando uma venda for realizada. Caso um statement_descriptor não esteja configurado na conta do vendedor, será utilizado a razão social, no caso de conta PJ, ou nome completo, no caso de conta PF.

É possível realizar uma configuração dinâmica do statement_descriptor por transação, bastando para isso incluir o parâmetro na chamada de api para criação de venda.

O statement_descriptor é limitado à 22 caracteres, não devendo utilizar caracteres especiais ou somente números.

curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url https://api.zoop.ws/v1/marketplaces/99999999999999999999999999990000/transactions \
    --data '{    
        "amount": 7,
        "currency": "BRL",
        "description": "venda",
        "on_behalf_of": "5715c67929994f919a21f1323e407e11",
        "customer": "c07ee65cda84495787cd091fea554549",
        "statement_descriptor": "LOJA JOAO",
        "payment_type": "credit"
    }'

Armazenando dados na transação

Você pode armazenar dados de referência nas transações criadas de maneira a facilitar a busca e conciliação das vendas com seu sistema.

Suportamos dois modelos de armazenamento de dados. Você pode enviar informações através do campo metadata, um campo chave / valor, sendo estes dados registrados na venda e retornados nas chamadas de api de transactions.

Uma forma aconselhável de registrar dados na transação é através do atributo reference_id. Através deste campo você pode enviar um identificador do pedido no seu sistema, sendo possível realizar um filtro de transações pelo id de referência nas APIs ou no dashboard.

curl --request POST \
    --header "Content-Type: application/json" \
    --user zpk_test_EzCkzFFKibGQU6HFq7EYVuxI: \
    --url https://api.zoop.ws/v1/marketplaces/99999999999999999999999999990000/transactions \
    --data '{    
        "amount": 7,
        "currency": "BRL",
        "description": "venda",
        "on_behalf_of": "5715c67929994f919a21f1323e407e11",
        "customer": "c07ee65cda84495787cd091fea554549",
        "statement_descriptor": "LOJA JOAO",
        "reference_id": "10001",
        "payment_type": "credit",
        "metadata": {
            "my-own-tid": "12345"
        }
    }'

📘

Atenção

As chamadas acima são meramente ilustrativas.