Create PayIn

post

https://api.nxp.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.

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 | null

DocumentNumber restricts the charge to a payer holding this CPF or CNPJ,
digits only. Omit to accept payment from anyone.

expiration

integer

≥ 0

Expiration is how long the QR code stays payable, in seconds. Omit or send
0 to take the provider's default.

payer_name

string | null

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

txid

string

required

length between 1 and 255

Txid is your own identifier for the charge, and the key you fetch it back
by. A txid that is already in use is rejected, so give every charge its
own.

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

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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 - amount, txid format, 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