You can use sub accounts when you need to integrate more than one website using the same account. To enable this feature you must ask the EBANX Integration Team at integration@ebanx.com.

This feature is available in both Direct API and Checkout Request.

Direct API

In addition to enabling this feature within EBANX, you must also send a new object:

payment.sub_account

JSON object, required

Object containing the sub account’s name. Required for payments where the sub account feature is being used.

payment.sub_account.name

string, Length: 32, required

Name of the sub account

payment.sub_account.image_url

string, Length: 200, required

URL of the logo of the sub account. OBS: It MUST be a HTTPS URL, otherwise, you will receive and error message.

An example request is as follows:

Checkout Request

In addition to enabling this feature within EBANX, you must also send two new parameters:

sub_acc_name

string, Length: 32, required

Name of the sub account

sub_acc_image_url

string, Length: 200, required

URL of the logo of the sub account. OBS: It MUST be a HTTPS URL, otherwise, you will receive and error message.

An example request is as follows:

curl -X POST 'https://sandbox.ebanx.com/ws/request' \
    -d 'integration_key=fd29a3b39d8f7bffa31cecfe895236ba5b43683e225f9d4de78ac3bdca7dfb184abfed285cc99d5b13813672e586f9cf9eb8' \
    -d 'name=José Silva' \
    -d 'email=josesilva@example.com' \
    -d 'country=br' \
    -d 'payment_type_code=boleto' \
    -d 'merchant_payment_code=d59cb7166e7' \
    -d 'currency_code=BRL' \
    -d 'amount=100'\
    -d 'sub_acc_name=Merchant+Test+Name'\
    -d 'sub_acc_image_url=https://www.colourbox.com/preview/9155263-store-front.jpg'