Create Pix por biometria payment request

post

https://api.pluggy.ai/payments/requests/pix-biometric

Creates a payment request paid with Pix por biometria. Send its paymentUrl to the payer: on the first payment on a device they link an account at their bank and create a passkey; later payments on that device are confirmed with biometrics, without a bank redirect. One payment request per purchase. Not available in sandbox.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

number

required

≥ 0.01

Amount in BRL, with up to two decimal places.

recipientId

uuid

required

Recipient that receives the payment. Bank account recipients only: smart accounts are not supported.

description

string

length ≤ 140

Shown to the payer.

customerId

uuid

Payment Customer that identifies the payer. The payment page uses its CPF/CNPJ and does not ask for it; without it the payer types their CPF.

clientPaymentId

string

length ≤ 200

Your own identifier for the payment.

callbackUrls

object

Redirect urls after the payment was completed or ended in error status

linkedJourney

boolean

Defaults to false

Offer the payer to also share their account balance and overdraft limit while the link lasts (optional for the payer). Read it with the enrollment balance endpoint.

isSandbox

boolean

Pix por biometria has no sandbox: true is rejected with PIX_BIOMETRIC_SANDBOX_NOT_SUPPORTED.

Responses

200The payment request

400Invalid parameters, a sandbox request, or a smart account recipient

403Payment Initiation is not enabled for the client

404Recipient or customer not found