Version: current

Verify Account

About this guide

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

How it works

  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 unique and secret integration key.
    targetProvider that will process the payment (mercadopago, pix, etc)
    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=mercadopago' \
    -d 'target_account=janedoe@someone.co' \
    -d 'country=br'

    And a successful query will return a JSON Object with status "valid".

    {
    "status": "valid",
    "message": "Account is valid"
    }
    {
    "status": "valid",
    "message": "Account does not have KYC complete in provider"
    }

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

    {
    "status": "invalid",
    "message": "Account not able to receive transfers in this country"
    }
    {
    "status": "invalid",
    "message": "Account does not exist in provider"
    }

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

  • If you’re not our partner yet and would like to know more about our prices and conditions please fill ou this form and our comercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at integration@ebanx.com.
Last updated on by ferpa2012