Skip to main content
POST
Essa rota utiliza os certificados e o Bearer Token de Cash Out.

Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de Cash Out, a chave e a senha na requisição:
--cert
file
required
Certificado de Cash Out do cliente (client.crt).
--key
file
required
Chave privada do cliente (client.key).
--pass
string
required
Senha para descriptografar a chave .key, enviada por e-mail junto com os certificados.

Headers

Content-Type
string
required
Formato do corpo da requisição. Use application/json.
Authorization
string
required
Bearer Token de Cash Out. Formato: Bearer {access_token}.
x-idempotency-key
string
required
Chave única por transferência. Evita transferências duplicadas: se a mesma chave for reenviada, a transferência não é processada de novo.

Body

priority
string
Opções: HIGH ou NORM. Padrão: NORM.Com HIGH, o pagamento é processado instantaneamente e retornado na própria requisição (a requisição fica aberta até a transferência ser concluída). Com NORM, o pagamento é enfileirado e, após o processamento, o resultado é enviado por webhook.
paymentFlow
string
Opções: APPROVAL_REQUIRED ou INSTANT. Padrão: INSTANT.Com APPROVAL_REQUIRED, a transferência precisa de confirmação adicional para ser aprovada. Com INSTANT, a transferência é executada instantaneamente, sem necessidade de aprovação.
expiration
integer
Tempo em segundos que o saque pode ficar na fila de transferência antes de ser cancelado. Entre 1 e 10800. Só se aplica quando priority for NORM. Padrão: 600.
payment.currency
string
required
Moeda corrente do pagamento. Deve ser sempre "BRL".
payment.amount
number
required
Valor da transferência. Exemplo: 50.00.
qrCode
string
required
Código Pix copia e cola do QR Code a ser pago.

Resposta

id
string
Identificador da transferência na Super Finance.
status
string
Status da transferência. Exemplos: PROCESSING, LIQUIDATED, REJECTED.
priority
string
Prioridade aplicada (HIGH ou NORM).
paymentFlow
string
Fluxo aplicado (INSTANT ou APPROVAL_REQUIRED).
payment
object
Valor da transferência (currency, amount).
qrCode
string
Código Pix copia e cola pago.
idempotencyKey
string
Chave de idempotência usada na requisição.
createdAt
string
Data e hora de criação (ISO 8601).