Enviar Pix

Envia um Pix outbound via Autra (POST /spi/v1/payments).

Suporta 4 modos de inicialização: KEY (chave), MANUAL (dados bancários),
QR_CODE_STATIC, QR_CODE_DYNAMIC.

Auto-enrichment para KEY (importante)

A Autra exige credit_party.bank (ISPB + agência + conta + tipo) e
end_to_end_id (com ISPB do destino, exigência BACEN) mesmo quando
initiation.type=KEY
— mesmo o schema deles marcando bank como
required. Sem isso a Autra devolve 400 REQUIRED_ATTRIBUTE_MISSING.

Pra simplificar o app, o backend Autra faz o enrichment automaticamente:
quando o request chega com initiationType=KEY e SEM creditParty.bank,
o backend chama GET /spi/dict/v5/validate/{key}/account/{accountId}
internamente, monta o bank com os valores retornados (os campos
sensíveis vêm criptografados RSA pela Autra e passam crus — Autra decripta
do lado dela) e sobrescreve end_to_end_id pelo gerado pelo DICT.

Resultado: pra KEY basta enviar creditParty.key (+ amount + device

  • PIN). Se o app passar creditParty.bank explicitamente, esse tem
    precedência e o backend pula o enrichment.

Outros pontos

  • Assíncrono: Autra responde 202 e status final chega via webhook
    (pic_*). Polling on-demand disponível em GET /pix-payments/{id}.
  • Device obrigatório: device.deviceId deve estar AUTHORIZED em
    banking_devices (BACEN 491). A Autra é responsável contratual pela
    autenticação local do pagador (biometria/PIN no app).
  • PIN transacional: enviar no header X-Account-Pin (não no body).
  • Idempotência: idempotencyKey (body ou header Idempotency-Key).
    Mesma key reenviada devolve o registro original.
  • Coexistência: esta rota é Autra. A rota legacy
    POST /v1/banking/pix/transfers (Caradhras) continua funcionando.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Envia um Pix outbound via Autra /spi/v1/payments.

Modelo assíncrono: Autra responde 202 e a confirmação real chega via webhook (status final em COMPLETED, FAILED ou REJECTED).

Autenticação: Autra não valida senha do pagador. A Autra é responsável contratual pela autenticação local (biometria/PIN no app). O backend exige device.deviceId autorizado em banking_devices (BACEN 491) e propaga device.authentication (flag inteira) como atestado.

Idempotência: idempotencyKey (body ou header Idempotency-Key) vira business_key na Autra. Reenvio com mesma key devolve o registro original.

string
enum
required

Tipo de inicialização:

  • KEY: por chave Pix (creditParty.key obrigatório). Backend faz auto-enrichment do bank via DICT.
  • MANUAL: por dados bancários (creditParty.bank obrigatório, sem chave).
  • QR_CODE_STATIC / QR_CODE_DYNAMIC: por QR Code (qrTxId obrigatório, creditParty.key também).
  • PAYMENT_INITIATOR: iniciado por serviço de iniciação de pagamento (Open Finance). Reservado, não-suportado ativamente.
Allowed:
string

tx_id da cobrança (obrigatório para QR_CODE_*).

float
required
≥ 0.01
creditParty
object
required

Beneficiário do Pix.

device
object
required

Atestado de autenticação local. deviceId deve estar AUTHORIZED em banking_devices.

string

Opcional. Categoria de saldo (multibenefit). Omita para usar a categoria "general".

string
length ≤ 140

Texto livre que vai em pacs.008 RemittanceInformation. Não pode conter URLs (http* é bloqueado pela Autra).

string
Headers
string
Responses

403

Token inválido.

404

Conta não encontrada.

422

DEVICE_REQUIRED (device.deviceId ausente) ou DEVICE_NOT_AUTHORIZED (device não está AUTHORIZED).

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json