Skip to main content
POST
Create a Transaction

Pagamentos por voucher

Use method: "voucher" para instruções locais de pagamento como Boleto, SPEI, Mercado Pago, Webpay, CODI e PSE. Não envie nomes das opções locais para este endpoint. Para o fluxo completo de voucher, países suportados, tipos de documento e campos de resposta, veja Receber pagamentos por voucher.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
amount
integer
obrigatório
Intervalo obrigatório: 0 < x <= 100000000
method
enum<string>
padrão:pix
obrigatório

Payment method to be used for the transaction.

Opções disponíveis:
pix,
voucher,
credit_card
buyer
object
obrigatório

Buyer information for the transaction.

products
object[]
obrigatório

List of products associated with the transaction.

Required array length: 1 - 100 elements
external_ref
string | null

Optional idempotency key or external reference from your system.

fx_quote_id
string<uuid> | null

Quote de câmbio confirmado com o comprador (POST /fx/quotes). Obrigatório quando a empresa repassa o câmbio ao comprador e a cobrança não passa pelo checkout hospedado.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
currency
enum<string>
padrão:BRL

Transaction currency. Defaults to BRL.

Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
GTQ,
MXN,
PYG,
PEN,
USD,
UYU
operation
enum<string>

Optional voucher sub-method. Only used for MXN voucher payments (SPEI); ignored otherwise. Defaults to SPEI.

Opções disponíveis:
SPEI
installments
integer | null

Number of installments for the transaction when applicable.

Intervalo obrigatório: 1 <= x <= 12
interest_rate
number | null

Installment interest rate (%) embedded in the charged amount, when applicable.

Intervalo obrigatório: 0 <= x <= 100
token
string

Optional payment token for card transactions. Use 'pgct_' for single-use or 'pgpm_' for reusable (upsell) tokens.

Pattern: ^(pgct_|pgpm_)
notify_url
string | null

Optional HTTPS URL to receive webhooks for this transaction.

Maximum string length: 2048
metadata
string | null

Optional metadata string for your own reference.

informations
object[]

Custom key/value metadata to attach to the transaction and echo on the webhook.

Maximum array length: 50
traceable
boolean
padrão:false

Whether the transaction should be traceable for fraud or risk analysis.

ip_address

Public IPv4 or IPv6 address of the buyer or request origin.

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$
Exemplo:

"8.8.8.8"

Resposta

HTTP 201 response

success
boolean
obrigatório
requestId
string
obrigatório
data
object
obrigatório