Skip to main content
POST
Generate a Pix BR code for an autoramp

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring an Autoramp operation is only processed once

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.

Path Parameters

autoramp_id
string<uuid>
required

The autoramp ID

Body

application/json; charset=utf-8

Parameters for generating a Pix BR code for an autoramp

reference
string
required

Your reference for the payment, 1 to 19 alphanumeric characters. It is returned to us with the payment and shown as the transaction's inbound payment reference.

Required string length: 1 - 19
Pattern: ^[a-zA-Z0-9]+$
amount
string<decimal>

Fixed amount to request, in BRL, minimum 0.01 and at most 2 decimal places. Omit to let the payer choose the amount.

Response

BR code generated

A Pix BR code for an autoramp

br_code
string
required

The Pix copy-and-paste (EMV) payload to pay