Skip to main content
Start a Pix payment

Authorizations

Authorization
string
header
required

OAuth 2.0 access token of the Visor CLI browser login (authorization code with PKCE). Only the first-party Visor CLI client can use it on this API.

Headers

Idempotency-Key
string
required

A value you choose for this Pix, 1 to 128 letters, digits, or - _ . :. Send the same value when you retry. A UUID per Pix works well.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_\-.:]+$

Body

application/json

The Pix to start

amount
string<decimal>
required

The amount in BRL as a positive decimal string with up to 2 decimal places

Example:

"20.00"

pix_key
string
required

The Pix key as the user typed it: an email, a CPF, a CNPJ, a phone (with or without +55), or a random key (EVP).

bank
string

The bank the user pays from. Without it, Visor uses the one bank the user already linked, or answers BANK_REQUIRED.

Maximum string length: 100
description
string
Maximum string length: 140
key_type
enum<string>

The key type. Send it when the key can be a CPF and a phone (AMBIGUOUS_PIX_KEY).

Available options:
phone,
cpf,
cnpj,
email,
evp

Link the bank again before the payment, on the device that opens start_url. A bank link (its passkey) belongs to the device that created it, and a bank can be linked on several devices. Send true to confirm on a device that is not linked yet; bank.linked is then false and start_url opens the bank page first.

Response

The started Pix, or the one already started with the same key

data
PixPayment · object
required