Version: current

Transfer Balance

About this guide

This guide quickly demonstrates how to transfer balance from your settlement to your payouts in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

How it works

  1. Transfer balance using the /ws/transfer/create end-point

    To transfer balance, you will use the /ws/transfer/create endpoint.

    The following fields are required:

    FieldDescription
    external_referenceThe unique identifier you provide to the transfer
    amountAmount you wish to transfer
    sourceSource of the amount. This value must be payment_balance

    The following example shows how to create a transfer using the payment balance from your settlement:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/create' \
    -d 'integration_key=your_test_integration_key' \
    -d 'external_reference=PAYOUT_TRANSFER_02' \
    -d 'amount=150' \
    -d 'source=payment_balance'

    And a successful creation will return a JSON Object with type "success" and a payout object with all the details of the newly created Transfer.

    {
    "type": "success",
    "transfer": {
    "uid": "11ce3097af9ccf601b11038123962d3feded348ed",
    "external_reference": "PAYOUT_TRANSFER_02",
    "status": "OP",
    "request_date": "2017-02-08 17:33:56",
    "confirm_date": null,
    "cancel_date": null,
    "amount": "150.00",
    "settlement_code": null,
    "source": "payment_balance"
    }
    }

Transferring Balance via Dashboard

You can also transfer to your available balance through your Dashboard in the Overview section of the Payout tab. Click on the Add Balance option and choose the amount you want to transfer from the amount available from your settlement.

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 Fernando Pankiewicz Gomes