Criar transação

Para criar uma transação, use a rota /transactions, tanto para cartão de crédito, boleto ou PIX.

Cartões para testes em sandbox:

Número do Cartão	Bandeira	Status	Descrição
4012 8888 8888 1881	Visa	not_authorized	Transação não autorizada pelo banco emissor.

POST{apiUrl}/transactions

URL base da API

Token de autenticação

Body Params

postbackUrlstringoptional

URL que receberá atualizações da transação

metadatastringoptional

Parâmetros adicionais da loja

cod_externalstringoptional

Código do pedido na loja

3dsbooleanoptional

Força uso ou não do 3DS (requer autorização da Dom)

curl --request POST \
  --url "{apiUrl}/transactions" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Campos da resposta

idstring

ID único da transação (UUID)

created_atstring

Data de criação

updated_atstring

Data de atualização

cod_externalstring

Código externo da loja

amountinteger

Valor total em centavos

liquid_amountinteger

Valor líquido em centavos

liquidationarray

Dados de liquidação

refundsarray

Estornos realizados

currencystring

Moeda (BRL)

statusstring

Status da transação

msgstring

Mensagem de retorno

payment_methodstring

Meio de pagamento: credit_card, boleto ou pix

card_code_authstring

Código de autorização do cartão

card_brandstring

Bandeira do cartão

card_binstring

BIN do cartão

installmentsinteger

Número de parcelas

boleto_urlstring

URL do PDF do boleto

boleto_digitable_linestring

Linha digitável do boleto

pix_qrcodestring

QR Code do Pix (base64)

pix_qrcode_urlstring

URL da imagem do QR Code

pix_contentstring

Conteúdo do Pix copia e cola

pix_expirestring

Data de expiração do Pix

items[].descriptionstring

Descrição do item

items[].priceinteger

Preço em centavos

items[].quantityinteger

Quantidade

customer.namestring

Nome do cliente

customer.emailstring

E-mail

customer.mobile_phonestring

Telefone

customer.documentstring

CPF ou CNPJ

customer.document_typestring

Tipo de documento

customer.birthdatestring

Data de nascimento

customer.genderstring

Gênero

customer.address.streetstring

Rua

customer.address.numberstring

Número

customer.address.neighborhoodstring

Bairro

customer.address.zip_codestring

CEP

customer.address.citystring

Cidade

customer.address.statestring

shipping.streetstring

Rua de entrega

shipping.numberstring

Número

shipping.neighborhoodstring

Bairro

shipping.zip_codestring

CEP

shipping.citystring

Cidade

shipping.statestring

fee_details.amountnumber

Valor da taxa cobrada

fee_details.fee_payerstring

Quem paga a taxa

fee_details.typestring

Tipo da taxa

metadatastring

Dados adicionais da loja

postbackUrlstring

URL de postback configurada

curl --request POST \
  --url "{apiUrl}/transactions" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": {
      "name": "João da Silva",
      "email": "joao@exemplo.com",
      "document": "11111111111",
      "document_type": "CPF",
      "mobile_phone": "48999999999"
    },
    "items": [{ "description": "Produto", "price": 50, "quantity": 2 }],
    "payment": {
      "total": 100,
      "payment_method": "credit_card",
      "credit_card": {
        "installments": 1,
        "holder_name": "JOAO DA SILVA",
        "token": "string"
      }
    }
  }'