Generate a Payin Code
Payins
Generate a Payin Code
Generates a payin code to collect funds from a payer. The code type is selected by currency: BRL returns a PIX copy-and-paste code, BOB returns a QR code, and any other currency returns a default QR.
POST
Generate a Payin Code
The response always includes a renderable
qrCode image. Depending on the
currency, additional fields are returned:
BRL→ PIX copy-and-paste code inbrCode.BOB→ QR payload string inqrPayload.- Any other value (default
USD) → default QR with no extra fields.
Body
string
required
Merchant’s order reference.
number
required
Amount to collect, expressed in
currency. Must be at least
0.01.string
default:"USD"
Currency code that determines the payin code type:
BRL returns a
PIX code, BOB returns a QR code, and any other value returns a
default QR.string
Reference used for idempotency. If omitted, it defaults to
orderId.string
Sub-merchant or payer reference.
number
Tax portion included in the amount (if applicable). Must be
0 or
greater.string
Expiration timestamp (ISO-8601). Defaults to 30 minutes from creation and may
not exceed 24 hours.
Response
boolean
Indicates whether the payin code was generated successfully.
string
The unique payment identifier, formatted as
payin_<uuid>.
Use it to look up the payin status.string
The renderable QR image, encoded as a data URL.
string
The ISO-8601 timestamp when the payin code expires.
string
The PIX copy-and-paste code. Present when
currency is
BRL.string
The raw QR payload string. Present when a QR code is generated (for example,
BOB).