Skip to main content
POST
Solicitar transferência Pix

Authorizations

Authorization
string
header
required

Use Authorization: Bearer nyx_live_...

Headers

Idempotency-Key
string
Maximum string length: 100

Body

application/json
amount
number
required

Obrigatório para chave Pix e para BR Code estático sem valor. Omita quando o código já definir o valor.

Required range: x >= 3
pixKey
string
required
pixKeyType
enum<string>
required
Available options:
cpf,
cnpj,
email,
phone,
random
externalId
string

Alternativa ao cabeçalho Idempotency-Key.

Maximum string length: 100
description
string
Maximum string length: 140
coverFee
boolean
default:true
webhookUrl
string<uri>
destination
object

Destino moderno. Em pix_copy_paste ou qr_code, o BR Code é validado pela processadora. O valor do código prevalece; amount só é usado em código estático sem valor.

Response

Requisição idempotente existente