Handling User Driven Updates

Overview

Pix Automático allows users to manage their enrollments directly through their banking apps. They are able to update both the Max Amount, for variable subscriptions, and the access to their credit limit. This guide quickly demonstrates how to handle user driven updates in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

How it works

To handle updates performed by the users through EBANX Direct API, please follow the steps below.

  1. EBANX notifies enrollment update

    Your title

    As soon as the enrollment is updated by the customer's bank a Status Update notification is sent to the URL defined in Success URL in the enrollment creation.

    {
    "operation":"enrollment_status_change",
    "notification_type":"update",
    "merchant_enrollment_code":"{{unique_enrollment_code}}"
    }

    Using the ID provided in merchant_enrollment_code, use the ws/userenrollment/query endpoint to get the latest status of the enrollment.

    Check the example:

    curl POST 'https://sandbox.ebanxpay.com/userenrollment/query' \
    --header 'Content-Type: application/json' \
    --data '{
    "integration_key": "{{integration_key}}",
    "merchant_enrollment_code": "{{unique_enrollment_code}}"
    }'

    A successful request will return a JSON response like the one below, with a status of CANCELED for the enrollment approved by the customer.

    {
    "status": "SUCCESS",
    "payment_type_code": "pix-automatico",
    "enrollment": {
    "merchant_enrollment_code": "{{unique_enrollment_code}}",
    "country": "BR",
    "currency_code": "BRL",
    "back_urls": {
    "success": "{{success_url}}",
    "failure": "{{failure_url}}"
    },
    "subscription": {
    "subscription_name": "Descriptor of the subscription.",
    "first_payment_date": "2024-01-17",
    "expiration_date": "2024-07-03",
    "frequency": "weekly",
    "max_amount": 39.90,
    "retries": true
    },
    "customer": {
    "email": "{{customer_email}}",
    "document": "{{customer_document}}"
    },
    "pix":{
    "credit_allowed": false
    },
    "qr_code_value": "00020101021226740014br.gov.bcb.pix2552pix.ebanx.com\/qr\/v2\/F2D9448AA5B94ED3450A4A8933748F5952040000556345643602BR5911Ebanx LTDA.6008CURITIBA62070503***63045022"
    }
    }

    In the example above, the user updated both the max_amount and pix.credit_allowed parameters.

    Important

    Note that, for fixed amount enrollments, the user is not able to change the amount. Also, the user can only change max_amount to values higher than the one established in the enrollment request, not lower.

note

Pix Automático goes live on June 16th 2025. Stay tuned for Sandbox Environment availability on December 1st 2024!

Still need help?

Help Image

We hope this article was helpful. If you still have questions, you can explore the following options:

Last updated on by Samuel Santos De Oliveira