POST
/
gateway
/
pix
/
receive

Authorizations

x-public-key
string
headerrequired

Chave pública para autenticação da API. Você consegue obter a chave pública na página de gateway do seu painel de controle.

x-secret-key
string
headerrequired

Chave secreta para autenticação da API. Você consegue obter a chave secreta na página de gateway do seu painel de controle.

Body

application/json
identifier
string
required

Identificador único da transação. Deve ser criado pela sua aplicação, e deve ser único para cada transação.

dueDate
string

Data de vencimento opcional do Pix. Deve ser no formato YYYY-MM-DD.

amount
number
required

Valor do Pix a ser recebido.

callbackUrl
string

URL de callback para notificações, opcional.

description
string

Descrição opcional do pagamento.

client
object
required
products
object[]

Lista de produtos, opcional.

split
object

Response

200 - application/json
transactionId
string

ID único da transação, criado por nós. Guarde esse ID para futuras consultas.

status
enum<string>

Status da transação.

Available options:
OK,
FAILED
pix
object

Informações do Pix gerado. Dependendo do canal de pagamento, os campos base64 e image podem não estar presentes. Porém, o campo **code sempre estará presente.