Create PayIn

post

https://api.env.techworks.app/api/payin

Generates a dynamic Pix QR code for the authenticated account. The
returned qr_code_string is the copy-and-paste (EMV) payload to present
to the payer; the pay-in starts as pending and is confirmed
asynchronously, either by polling GET /api/payin/{txid} or by the
PayInCompleted webhook.

This route is idempotent: an Idempotency-Key header is required, and a
repeat of the same key replays the first response instead of creating a
second charge.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Txid format

Must be 26 to 35 characters long, and contain only letters and numbers (alphanumeric characters).

A good format suggestion is:

{
  "txid": "<PREFIX><YYYYMMDDHHmm><16 random characters>",
  "amount": 10
}

Possible Status

paid
pending

Body Params

PayIn Details

amount

number

required

Amount is the charge in reais, with at most two decimal places.

document_number

string

required

length between 11 and 18

DocumentNumber is the payer's CPF or CNPJ. Send the digits; punctuation is
accepted and stripped. It identifies the payer; whether the charge refuses
anyone else depends on the provider.

expiration

integer

≥ 0

Expiration is how long the QR code stays payable, in seconds; 0 takes the provider default.

payer_name

string

required

length between 1 and 200

PayerName is the payer's name, shown to them in their banking app.

txid

string

required

length between 1 and 255

Txid is your unique identifier for the charge, and the key you fetch it back by.

Headers

Idempotency-Key

string

required

Client-generated key that makes the request replayable. Reusing a key returns the first response for one hour instead of creating a second pay-in.

Responses

Txid format

Possible Status

200The pay-in, always created as pending

400Malformed JSON body, a missing Idempotency-Key header, or an inactive account

401Bearer token missing, expired, or presented from an IP outside the key's allowlist

404The token's account no longer exists

409A request with this Idempotency-Key is still in flight; retry once it settles

422The payload failed validation - a missing required field, an amount with more than two decimal places or above the provider's maximum, txid format, an invalid CPF or CNPJ, or a txid already in use

500No provider could accept the charge, or an internal failure. Never carries internal detail

503Scheduled maintenance: the queue is paused and no order is being accepted