Sign in

v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Transações

Criar transação

post/v1/marketplace/transactions

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

establishment_idstring required

ID do estabelecimento.

Request body

payment_type'CREDIT' | 'PIX' | 'BILLET' required

Tipo de transação. - CREDIT: Crédito. - PIX

amountnumber required

Valor da transação em centavos.

installmentsnumber

Quantidade de parcelas. Obrigatório somente para transações do tipo crédito.

interest'STORE' | 'CLIENT' required
  • CLIENT: o valor das taxas serão repassadas ao cliente, aumentando o valor bruto da transação. - STORE: o valor das taxas serão cobradas do estabelecimento, mantendo o valor bruto da transação.
session_idstring

ID da sessão de antifraud.

antifraud_type'THREEDS' | 'IDPAY'

Tipo de antifraude utilizado. - THREEDS: Antifraude 3DS. - IDPAY: Antifraude IDPAY.

Example request

{
  "billet": {
    "due_date": "2026-07-15",
    "issue_date": "2026-07-02",
    "days_until_expiration": 5,
    "iof_percentage": "0.00820",
    "messages": [
      "Não receber após o vencimento"
    ],
    "discount": {
      "items": [
        {
          "limit_date": "2026-07-10",
          "value": 5
        }
      ]
    },
    "fine": {
      "percentage": "2.00",
      "quantity_days": 3
    },
    "interest_percentage": "1.00"
  },
  "reference_id": "ABC-123"
}

Response

_idstring required

Identificador único da transação.

status'CREATED' | 'PENDING' | 'APPROVED' | 'PAID' | 'FAILED' | 'REFUNDED' | 'DISPUTED' | 'CANCELED' | 'CHARGEBACK' required

Status da transação.

amountnumber required

Valor líquido em centavos.

original_amountnumber required

Valor bruto em centavos.

interest'STORE' | 'CLIENT' required
  • CLIENT: o valor das taxas serão repassadas ao cliente, aumentando o valor bruto da transação. - STORE: o valor das taxas serão cobradas do estabelecimento, mantendo o valor bruto da transação.
feesnumber required

Valor total de taxas em centavos.

type'CREDIT' | 'DEBIT' | 'PIX' | 'BILLET' required

Tipo da transação.

gateway_authorization'PAYTIME' | 'ZOOP' | 'PAGSEGURO' required

Subadquirente responsável pela transação.

installmentsnumber required

Número de parcelas.

created_atstring date-time required

Data da transação.

emvstring

Código "copia e cola" de transações do tipo Pix.

reference_idstring

Identificador definido pelo cliente para controle e rastreamento interno da transação.

Example response

{
  "billet": {
    "due_date": "2026-07-18",
    "issue_date": "2026-06-18",
    "entry_date": "2023-09-09",
    "document_kind": "BOLETO_PROPOSTA",
    "iof_percentage": "32.45325",
    "messages": [
      "Mensagem 1",
      "Mensagem 2"
    ],
    "digitable_line": "03399356782060000000201234501011693970000000100",
    "barcode": "03396939700000001009356720600000000123450101",
    "qr_code_url": "pix.santander.com.br/qr/v2/cobv/...",
    "pdf_url": "https://storage.example.com/billets/billet.pdf",
    "configured_amount": 44308,
    "configured_original_amount": 45678,
    "discount": {
      "type": "VALOR_DATA_FIXA",
      "items": [
        {
          "value": 55,
          "limit_date": "2026-12-12"
        }
      ]
    },
    "fine": {
      "percentage": "1.20",
      "quantity_days": 5
    },
    "interest_percentage": "1.12",
    "payment": {
      "paid_via": "BARCODE",
      "date": "2025-11-24T13:46:52.015Z",
      "paid_amount": 10000,
      "interest_value": 150,
      "fine": 200
    }
  }
}