Rivus Pay
    Rivus Pay
    • Authentication
      • Intro
      • Get Access Token
        POST
    • PIX Payments
      • Intro
      • Payin
        • Create PIX Payin
        • Get PIX Payin by ID
        • Get PIX Payin by external ID
      • Payout
        • Create PIX Payout
        • Get PIX Payout by ID
        • Get PIX Payout by external ID
    • Balance
      • Get balance
        GET
    • Webhooks
      • Intro
      • Webhook app portal link
        POST

    PIX Payments

    What is PIX?#

    Pix is the Brazilian instant payment. The payment method created by the Central Bank (BC) in which funds are transferred between accounts in a few seconds, at any time or day. It's practical, fast and safe.

    What is CPF?#

    The CPF (Cadastro de Pessoa Física) is the Individual Taxpayer Registry. It is a document made by the Federal Revenue is used to identify taxpayers. CPF is an 11-digit number.

    What is PIX key?#

    In the Central Bank’s definition
    PIX keys are nicknames used to identify your account.
    In other words, they are a code that represents your Pix account. Individuals person may register a total of up to five keys for each bank account.
    You can use four types of PIX keys:
    NameDescriptionExample
    cpfCPF key(example: 467.123.456-78)
    emailEmail key(example: contato@email.com)
    phonePhone number key(example: 5511912345678)
    evpRandom key(example: q5sdd16i-88y9-5w74-8162-56e25efc85f8)

    Transactions status#

    PayIn#

    StatusDescription
    pendingWaiting payment
    paidPayment confirmed by banking institution
    expiredPayment expired
    refundedPayment refunded to payer
    errorPayment error

    Error#

    CodeMessage

    PayOut#

    StatusDescription
    pendingWaiting payment
    paidPayment confirmed by banking institution
    errorPayment error
    Errors details
    Previous
    Get Access Token
    Next
    Intro