PayAlpha
  1. Webhooks (Reference)
PayAlpha
  • Intro
  • Pix In
    • Create Pix In Transaction
      POST
    • Get Pix In Transaction
      GET
  • Pix Out
    • Create Pix Out Transaction
      POST
    • Get Pix Out Transaction
      GET
  • Webhooks (Reference)
    • Pix In - Payment Confirmed (transaction.paid)
      POST
    • Pix In - Refunded (transaction.refunded)
      POST
    • Pix Out - Transfer Confirmed (transfer.paid)
      POST
    • Pix Out - Transfer Failed (transfer.failed)
      POST
  • Wallets
    • Get Wallet Balances
      GET
  1. Webhooks (Reference)

Pix Out - Transfer Failed (transfer.failed)

POST
https://your-webhook-url.com/postback
Webhook sent when a Pix Out transfer fails.
Event: transfer.failed
Type: transfer
This webhook is sent to your configured postbackUrl when a Pix Out transfer fails. The failureReason and failureCode fields explain why the transfer failed.

Common Failure Codes#

CodeDescription
PIX_KEY_NOT_FOUNDInvalid or not found Pix key
INSUFFICIENT_FUNDSInsufficient wallet balance
PIX_KEY_VALIDATION_FAILEDPix key validation failed
PIX_TRANSFER_FAILEDTransfer failed at BaaS level

Requisição

Authorization
Envie suas requisições HTTP com um cabeçalho
Authorization
que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password
Exemplo:
Authorization: Basic *****************
Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-webhook-url.com/postback' \
--header 'X-Webhook-Signature: a1b2c3d4e5f6...' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "evt_1765499402328_40s6orldt",
  "type": "transfer",
  "event": "transfer.failed",
  "objectId": "575aaea8-3aff-42b4-897d-e7fc95254be8",
  "data": {
    "id": "575aaea8-3aff-42b4-897d-e7fc95254be8",
    "status": "failed",
    "amount": 10000,
    "fee": 60,
    "netAmount": 10000,
    "paymentMethod": "PIX",
    "externalRef": "withdraw_123",
    "pixKey": "john.doe@example.com",
    "pixKeyType": "EMAIL",
    "destinationName": "John Doe",
    "destinationDocument": "11122233344",
    "createdAt": "2025-12-12T00:29:37.682Z",
    "updatedAt": "2025-12-12T00:30:02.328Z",
    "failureReason": "Invalid or not found Pix key",
    "failureCode": "PIX_KEY_NOT_FOUND",
    "requiresManualReview": false,
    "metadata": {
      "feeModel": "DEDUCT_FROM_WALLET",
      "directPixKey": true,
      "bankAccountNickname": null
    }
  }
}'
Response Response Example
{}
Modificado em 2025-12-29 21:29:45
Página anterior
Pix Out - Transfer Confirmed (transfer.paid)
Próxima página
Wallets
Built with