PayAlpha
    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

    Intro

    Pix API – Overview#

    Pix API lets you receive and send Pix payments with Basic Auth and idempotency to avoid duplicates.
    urlBase: https://api.payalpha.io

    Key areas#

    Pix In: create Pix charges and query received payments.
    Pix Out: initiate Pix transfers (withdrawals) and query by id, externalRef, or idempotencyKey.
    Wallets: retrieve Pix wallet balances (available, blocked, reserve).
    Webhooks: receive transaction.* (Pix In) and transfer.* (Pix Out) events, including externalRef and optional HMAC signature.

    Auth & security#

    Basic Auth on all endpoints (secretKey:publicKey).
    Send Idempotency-Key (UUID) on Pix Out to guarantee single processing.
    If webhookSecret is provided, webhooks include X-Webhook-Signature (HMAC-SHA256 of the body).

    Conventions#

    Monetary values are in cents.
    externalRef can be sent on creation and returns in queries/webhooks for reconciliation.
    Pix Out webhooks include destination, beneficiary (when paid), and detailed status.
    Modificado em 2025-12-29 21:34:35
    Próxima página
    Pix In
    Built with