Skip to main content

Create a Payout

This guide provides a quick walkthrough for creating a payout with EBANX, using your existing Direct API integration to complete the process step by step.

Instructions​

To create a payout using EBANX Direct API, follow the steps below.

  1. Define your parameters

    Provide the required parameters listed below to create a payout.

    FieldDescription
    integration_keyYour EBANX integration key.
    external_referenceThe unique payout ID provided by you.
    countryThe two-letter country code for the customer country. In this case, the country is pe (Peru)
    amountThe amount in the specified currency (currency_code).
    currency_codeThree-letter code of the payout currency. In this case, the currency_code can be PEN (Peru)
    payeeA JSON object containing the details of the payee of your request.
    transaction_typeMust be filled with B2B (Legal entity to Legal entity) or B2C (Legal entity to Individual)
    Payee Details

    You can either include all payee details in the payout request, or create the payee in advance using the /ws/payee/create endpoint and reference them by document number.

    Document Types Allowed

    These types of documents are used by the payees.

    Document typeDescription
    RUCRegistro Único de Contribuyentes
    DNIDocumento Nacional de Identidade
    PASSPassport
    CECarnet de Extranjería

  2. Send payout request to EBANX

    To create a new Payout, you will use the /ws/payout/create endpoint.

    The following example is a payout create request to the payee's bank account sending bank data with bank details:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/create' \
    -d 'integration_key=your_test_integration_key' \
    -d 'external_reference=PAYOUT_EBANX_04' \
    -d 'country=pe' \
    -d 'amount=10' \
    -d 'currency_code=PEN' \
    -d 'transaction_type=B2C' \
    -d 'payee[name]=Han Solo' \
    -d 'payee[document]=352446182' \
    -d 'payee[document_type]=RUC' \
    -d 'payee[bank_info][bank_account]=number_of_bank_account' \
    -d 'payee[bank_info][account_type]=account_type'

    To create a payout for an organization entity (company) you should send additional fields holding the shareholders data:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/create' \
    -d 'integration_key=your_test_integration_key' \
    -d 'external_reference=PAYOUT_EBANX_04' \
    -d 'country=pe' \
    -d 'amount=10' \
    -d 'currency_code=USD' \
    -d 'transaction_type=B2B' \
    -d 'payee[name]=Han Solo' \
    -d 'payee[document]=776312467' \
    -d 'payee[document_type]=RUC' \
    -d 'payee[bank_info][bank_account]=number_of_bank_account' \
    -d 'payee[bank_info][account_type]=account_type'

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

    {
      "type": "success",
      "payout": {
        "uid": "a1352f5341c3c8c1e40ea9c06715f05778ff35ee",
        "external_reference": "PAYOUT_EBANX_04",
        "status": "OP",
        "request_date": "2020-09-18 13:26:53",
        "status_date": null,
        "paid_date": null,
        "cancel_date": null,
        "payee": {
          "name": "Han Solo",
          "email": "chew@bac.ca",
          "phone": "554112345678",
          "document": "352446182",
          "document_type": "RUC",
          "birthdate": null,
          "bank_info": {
            "bank_name": "104 Caixa Econ\u00f4mica",
            "bank_branch": "3708",
            "bank_account": "8251777-6",
            "account_type": "C",
            "bank_details": "001"
          }
        },
        "request_amount": "10.00",
        "request_currency": "PEN",
        "request_exchange_rate": "1.0000",
        "debit_amount": "10.00",
        "debit_fee": "0.15",
        "debit_amount_total": "10.15",
        "debit_currency": "PEN",
        "local_tax_amount": "0.12",
        "local_amount_total": "32.88",
        "local_currency": "PEN",
        "local_exchange_rate": "3.2997"
      }
    }

  3. Send commit request to EBANX

    Once the new Payout record is created it'll be committed automatically after 6 hours. Or you can use the /ws/payout/commit endpoint to start the payment process.

    Here's an example of a commit operation using the payout we've just created:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/commit' \
        -d 'integration_key=your_test_integration_key' \
        -d 'uid=0e495f7a4409c032d54376084b10b9c771e9b39f0'

    Once the new Payout is commited, a JSON Object with type "success" will be returned.

    {
      "type": "success",
      "message": "Payout has already been committed"
    }

  4. Congratulations!

    You have succesfully Created a Payout in Peru.

Creating a Payout via Dashboard​

You can also create a payout through your Dashboard in the Overview section of the Payout tab. Click on Create Payout, fill in the payee information, payout amount and click Create. Additionally, you can use Mass Payout feature to send payouts in batches

Still need help?

Help Image

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