Skip to main content
POST
Create a Transaction

Voucher payments

Use method: "voucher" for local payment instructions such as Boleto, SPEI, Mercado Pago, Webpay, CODI, and PSE. Do not send local option names to this endpoint. For the complete voucher flow, supported countries, document types, and response-field guidance, see Accept Voucher Payments.

Authorizations

Authorization
string
header
required

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

Body

application/json
amount
integer
required
Required range: 0 < x <= 100000000
method
enum<string>
default:pix
required

Payment method to be used for the transaction.

Available options:
pix,
voucher,
credit_card
buyer
object
required

Buyer information for the transaction.

products
object[]
required

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.

currency
enum<string>
default:BRL

Transaction currency. Defaults to BRL.

Available options:
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.

Available options:
SPEI
installments
integer | null

Number of installments for the transaction when applicable.

Required range: 1 <= x <= 12
interest_rate
number | null

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

Required range: 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
default: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])$
Example:

"8.8.8.8"

Response

HTTP 201 response

success
boolean
required
requestId
string
required
data
object
required