API Reference

Create a New Transaction

API responsável pelo processamento de transações financeiras

O processamento de transações financeiras será feito por meio desta API. Somente por meio desta integração, nossos clientes poderão realizar diversos tipos de transações com os gateways de pagamento contratados para o processamento.

Informações Gerais

A API de transações financeiras solicita as seguintes informações para todos os tipos de transações:

referenceId = Código da transação na base do cliente

merchantId = Código de identificação do merchant/seller na base do cliente

typeTransaction = Código do tipo de transação que será enviado pelo cliente

business = Enviar o valor fixo B2B2C

totalAmount = Valor total da transação que será processada

numberOfInstallments = Número total de parcelas da transação

observation = Campo de livre definição pelo cliente

billing = Objeto definido para identificar o pagador da transação

shipping = Objeto definido para identificar quem é o responsável por receber o produto da transação

splitRules = Objeto definido para identificar a forma de split da transação, caso ela seja aprovada

items = Objeto utilizado para identificar a lista de itens que estão incluídos no valor total da transação

payment = Objeto que será preenchido de acordo com o tipo da transação

📘

Tipos de Transações:

1 - Cartão de Débito

2 - Cartão de Crédito

3 - Boleto

4 - PIX

5 - BNPL

6 - ITP

7 - CRIPTO

API responsible for processing financial transactions

Financial transactions will be processed through this API. Only through this integration, our clients will be able to perform various types of transactions with the payment gateways contracted for processing.

General Information

The financial transaction API requests the following information for all types of transactions:

referenceId = Transaction code in the client's database

merchantId = Merchant/Seller identification code in the client's database

typeTransaction = Transaction type code that will be sent by the client

business = Send the fixed B2B2C value

totalAmount = Total value of the transaction that will be processed

numberOfInstallments = Total number of installments for the transaction

observation = Field with a free definition by the client

billing = Object defined to identify the payer of the transaction

shipping = Object defined to identify who is responsible for receiving the product of the transaction

splitRules = Object defined to identify the split method of the transaction, if it is approved

items = Object used to identify the list of items that are included in the total value of the transaction

payment = Object that will be filled according to the type of transaction

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!