Skip to main content

Verify Account PIX Key

This guide quickly demonstrates how to verify destination PIX key accounts whether it exists or not and if is valid. We will walk you through the basic steps to achieve this goal using your already existing API integration.

Instructions​

Follow the steps below:

  1. Verify account using the /ws/payout/verify_account end-point

    To verify account, you will use the /ws/payout/verify_account endpoint.

    The following fields are required:

    FieldDescription
    integration_keyYour EBANX integration key.
    targetProvider that will process the payment (pix_key)
    target_accountDestination account to query
    countryThe two-letter country code for the customer country. In this case, we'll show the method to br(Brazil)

    The following example shows how to verify a destination account:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/verify_account' \
        -d 'integration_key=your_test_integration_key' \
        -d 'target=pix_key' \
        -d 'target_account=janedoe@someone.co' \
        -d 'country=br'

    And a successful query will return a JSON Object with status "valid" and the recipient's bank information.

    {
        "recipient": {
            "name": "Jane Doe",
            "document": "12345678900",
            "bank_branch": "000",
            "bank_account": "0000000",
            "bank_agency": "0",
            "account_type": "CHECKING"
        },
        "status": "valid",
        "message": "Account is valid"
    }

    And a unsuccessful query will return a JSON Object with status "invalid", with a message explaining the reason.

    {
        "status": "invalid",
        "message": "Account does not exist in provider"
    }

    When reach limit of invalid verifications it will return a JSON Object with status "limit_rate_reached", with a message explaining the reason.

    {
        "status": "limit_rate_reached",
        "message": "Maximum attempts reached. Please try again in a few minutes."
    }

Still need help?

Help Image

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