Create a Transaction

Create a Transaction

QR Code Expiration Rules

  • Default Duration: 1800 seconds (30 minutes)

  • Minimum Allowed: 30 seconds

  • Maximum Allowed: 7200 seconds (2 hours)

Note: The transaction will automatically expire and become invalid after the specified TTL has elapsed.

Note2: Upon a successful response, the QR Code is available via the transaction.qrCodeUrl path, and the Pix copy/paste code is provided via transaction.dynamicPixCode. This data is also included in the transaction.pending webhook event notification

POST {{Environment_URL}}/vendors/v1/charges

Headers

Name
Value

Authorization

Bearer <token>

Body

Key
Description
Required
Data Type
Example

quotationId

Quotation ID obtained from Get Quotation or Get Quotation with Dynamic Fees

true

String

Quotation id obtained from quotation d59bb3c086159465a0baef009281bbfca76b2214

nature

Operation type

true

String

SERVICES_AND_OTHERS CASH_REMITTANCE GAMES_AND_BETS CRYPTO_ACTIVES UNKNOWN

paymentMethod

Use 'PIX' to create a PIX charge. Default: "PIX"

false

String

PIX

paymentMethodDetails

Object that accepts configurable details per Transaction.

false

Object

{ "expire": 1800, "document": "12345678901" }

paymentMethodDetails.document

Payer document. Optional; required if the transaction amount exceeds BRL 120.000,00

false

String

12345678901

paymentMethodDetails.expire

Time in seconds before the Transaction expires. Minimum: 30 seconds Default: 1800 seconds (30 minutes) Maximum: 7200 seconds (2 hours) This value defines the Time to Live (TTL) for the charge, with a default duration of 2 hours

false

Number

1800

metadata

A flexible field for attaching additional context or tracking information. Common uses include Storing monitoring/analytics IDs

false

Any

{ "product": "milkshake", "internal_id": "order_789", "tracking": ["campaign_2024", "promo_summer"] }

The PIX payment data is present in the Response QRCode Image: transaction.qrCodeUrl Copy and Paste: transaction.dynamicPixCode

Request body

Response

PreviousInstant PaymentNextGet Transaction by ID