POST
/
gateway
/
pix
/
send

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
key
string
required

Chave Pix do destinatário do pagamento.

keyType
enum<string>
required

Tipos de chave Pix permitidos para transação.

Available options:
cpf,
cnpj,
phone,
email,
random
amount
number
required

Valor do Pix a ser enviado.

client
object
callbackUrl
string

URL de callback para notificações, opcional.

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:
PENDING,
FAILED,
OK,
REJECTED,
CANCELED