Payout Request

The Payouts API allows you to request multiple payments using the balance available in your account.

To learn more about Payouts, refer to this article.

Payout request

This method allows you to request one or more Payouts using the funds settled in your account.

Request URL

You must invoke a POST request to the following URLs according to your needs.

Production: https://payout-api.bamboopayment.com/api/payout
stage: https://payout-api.stage.bamboopayment.com/api/payout

Request parameters

The following table shows the mandatory and optional parameters to create a Payout for all the countries.

Field	Type	Mandatory?	Description
`country`	`string(2)`	Yes	ISO code of the country in the format `ISO 3166-2`. List of countries available for Payouts.
`amount`	`integer`	Yes	Amount of the Payout, the format has two digits for decimals. Example 100 => $ 1,00.
`currency`	`string(3)`	Yes	ISO code of the origin currency. This currency must meet the one configured in your account. Find the currencies list here.
`reason`	`string`	No	Description of the Payout.
`destinationCurrency`	`string(3)`	Yes	ISO code of the currency in which the beneficiary will receive the payout. This parameter is not required for USD2L_ and L2L models, and the system will default to the currency of the destination country. This currency must meet the model of your account. For example: For USD2L, the `currency` parameter must be USD, and the `destinationCurrency` is optional. For USD2USD, both `currency` and `destinationCurrency` must be USD. For L2L, `currency` and `destinationCurrency` must be the chosen country’s currency. Find the currencies list here.
`reference`	`string`	Yes	Unique identifier of the Payout defined by you. It must be unique.
`type`	`integer`	Yes	Payout type. Set any of the following values: `1` for Cash `2` for Bank Transfer `3` for Wallet `4` for Instant Bank Transfer in Brazil
`InstantPaymentData` → `PixDocument`	`string`	Yes¹	The CPF/CNPJ number of the Payee configured as the PIX key. The number of digits for CPF* must be 11, and CNPJ must be 14.*
`InstantPaymentData` → `PixEmail`	`string`	Yes¹	The email address of the Payee configured as the PIX key. This parameter must be a valid email address.
`InstantPaymentData` → `PixPhone`	`string`	Yes¹	Phone number of the Payee configured as the PIX key. The phone number must start with `+55`.
`InstantPaymentData` → `PixRandom`	`string`	Yes¹	The random key the Payee generated as the PIX key.
`notification_Url`	`string`	No	Webhook to notify the result of the Payout. For more information about the configuration of this webhook, refer to this article.
`payee` → `FirstName`	`string`	Yes³	First Name of the Payee.
`payee` → `lastName`	`string`	Yes³	Last Name of the Payee.
`payee` → `companyName`	`string`	Yes³	Name of the company.
`payee` → `email`	`string`	No	Email address of the Payee.
`payee` → `phone`	`string`	No	Phone number of the Payee.
`payee` → `address`	`string`	No	Address of the Payee.
`payee` → `document` → `type`	`string`	Yes	Document type of the Payee. Find the document list here.
`payee` → `document` → `number`	`string`	Yes	Document number of the Payee.
`payee` → `bankaccount` → `number`	`string`	Yes²	Bank account number of the Payee. Take into account the following considerations: For Argentina, set the CBU/CVU. For Mexico, set the CLABE number.
`payee` → `bankaccount` → `type`	`integer`	Yes²	Account type of the Payee. Set `1` for Checking and `2` for Savings.
`payee` → `bankaccount` → `codebank`	`string`	Yes²	Bank code of the Payee. You can get the list of banks for a given country using the Get Bank list method. Alternatively, find the bank list here.

¹ Applies only to Brazil using Instant Bank Transfer. Otherwise, the object payee.InstantPaymentData and its parameters must not be present in the request.
² When using Bank transfer, these parameters are mandatory for ALL countries. For Instant Bank Transfer in Brazil, the object payee.bankaccount and its parameters must not be present in the request.
³ The fields firstName and lastName for an individual and companyName for a company are mandatory. If a payout is sent to a company, only the companyName field has to be completed, and if a payout is sent to an individual, only the firstName and lastName fields have to be completed.
Important: The firstName and lastName fields do not support numbers or special characters, only letters. The companyName field does accept all types of alphanumeric characters.

Request example

Refer to the corresponding tab according to the payee’s country.

Argentina: USD to ARS

{
    "country": "AR",
    "amount": 1000,
    "currency": "USD",
    "destinationCurrency":"ARS",
    "reason": "string",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Sara",
      "lastName": "Jáquez",
      "email": "sarasouez@mail.com",
      "phone": "099999999",
      "address": "Francisco  51 Gral. Ximena, AR-H 0376",
      "document": {
        "type": "CUIL",
        "number": "12345678901"
      },
      "bankAccount": {
        "number": "0000053600000000000566",
        "type": 1,
        "codeBank": "7"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Argentina: ARS to ARS

{
    "country": "AR",
    "amount": 1000,
    "currency": "ARS",
    "reason": "string",
    "destinationCurrency":"ARS",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Sara",
      "lastName": "Jáquez",
      "email": "sarasouez@mail.com",
      "phone": "099999999",
      "address": "Francisco  51 Gral. Ximena, AR-H 0376",
      "document": {
        "type": "CUIL",
        "number": "12345678901"
      },
      "bankAccount": {
        "number": "0000053600000000000566",
        "type": 1,
        "codeBank": "7"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

As mentioned before, the object payee.bankaccount must not be present in the request. Therefore, when using Instant Bank Transfer you need to send the request as follows:

Brazil: USD to BRL

{
    "country": "BR",
    "amount": 100,
    "currency": "USD",
    "destinationCurrency":"BRL",
    "reason": "string",
    "reference": "PayOut34",
    "type": 4,
    "InstantPaymentData": {
      "PixEmail":"tcosta@mail.com" // Can also be PixDocument, PixPhone, or PixRandom
    },
    "payee": {
      "firstName": "Tiago",
      "lastName": "Costa",
      "email": "tcosta@mail.com",
      "phone": "92799322",
      "address": "55489-272, Travessa Eduardo, 90 Esteves do Norte - CE",
      "document": {
        "type": "CPF",
        "number": "54562271779"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Brazil: BRL to BRL

{
    "country": "BR",
    "amount": 100,
    "currency": "BRL",
    "destinationCurrency":"BRL",
    "reason": "string",
    "reference": "PayOut34",
    "type": 4,
    "InstantPaymentData": {
      "PixEmail":"tcosta@mail.com" // Can also be PixDocument, PixPhone, or PixRandom
    },
    "payee": {
      "firstName": "Tiago",
      "lastName": "Costa",
      "email": "tcosta@mail.com",
      "phone": "92799322",
      "address": "55489-272, Travessa Eduardo, 90 Esteves do Norte - CE",
      "document": {
        "type": "CPF",
        "number": "54562271779"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Chile: USD to CLP

{
    "country": "CL",
    "amount": 1000,
    "currency": "USD",
    "destinationCurrency":"CLP",
    "reason": "string",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Mercedes",
      "lastName": "Garrido",
      "email": "merceddo@mail.com",
      "phone": "099999999",
      "address": "Camino Franco, 13, Atico 4, 93631, L Garay",
      "document": {
        "type": "CI",
        "number": "26068762K"
      },
      "bankAccount": {
        "number": "1234567890123450",
        "type": 1,
        "codeBank": "1"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Chile: CLP to CLP

{
    "country": "CL",
    "amount": 1000,
    "currency": "CLP",
    "destinationCurrency":"CLP",
    "reason": "string",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Mercedes",
      "lastName": "Garrido",
      "email": "merceddo@mail.com",
      "phone": "099999999",
      "address": "Camino Franco, 13, Atico 4, 93631, L Garay",
      "document": {
        "type": "CI",
        "number": "26068762K"
      },
      "bankAccount": {
        "number": "1234567890123450",
        "type": 1,
        "codeBank": "1"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Colombia: USD to COP

{
    "country": "CO",
    "amount": 100,
    "currency": "USD",
    "destinationCurrency":"COP",
    "reason": "string",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Diego",
      "lastName": "Silva",
      "email": "dsilva@mail.com",
      "phone": "099999999",
      "address": "Cra 23 # 123-45 Apto 601",
      "document": {
        "type": "CC",
        "number": "11111111"
      },
      "bankAccount": {
        "number": "2288",
        "type": 1,
        "codeBank": "1007"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Colombia: COP to COP

{
  "country": "CO",
  "amount": 100,
  "currency": "COP",
  "reason": "string",
  "destinationCurrency":"COP",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
    "firstName": "Diego",
    "lastName": "Silva",
    "email": "dsilva@mail.com",
    "phone": "099999999",
    "address": "Cra 23 # 123-45 Apto 601",
    "document": {
      "type": "CC",
      "number": "11111111"
    },
    "bankAccount": {
      "number": "2288",
      "type": 1,
      "codeBank": "1007"
    }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Mexico: USD to MXN

{
    "country": "MX",
    "amount": 1000,
    "currency": "USD",
    "destinationCurrency":"MXN",
    "reason": "string",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Rubén",
      "lastName": "Torres",
      "email": "rubentres@mail.com",
      "phone": "01 55 5601 7965",
      "address": "Coyoacan 2000",
      "document": {
        "type": "CURP",
        "number": "OEAF771012HMCRGR09"
      },
      "bankAccount": {
        "number": "123456789012345678",
        "type": 1,
        "codeBank": "2"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Mexico: MXN to MXN

{
    "country": "MX",
    "amount": 1000,
    "currency": "MXN",
    "reason": "string",
    "destinationCurrency":"MXN",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Rubén",
      "lastName": "Torres",
      "email": "rubentres@mail.com",
      "phone": "01 55 5601 7965",
      "address": "Coyoacan 2000",
      "document": {
        "type": "CURP",
        "number": "OEAF771012HMCRGR09"
      },
      "bankAccount": {
        "number": "123456789012345678",
        "type": 1,
        "codeBank": "2"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Peru: USD to PEN

{
  "country": "PE",
  "amount": 1000,
  "currency": "USD",
  "destinationCurrency":"PEN",
  "reason": "string",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
    "firstName": "Ornela",
    "lastName": "Olivera",
    "email": "ornelera@mail.com",
    "phone": "099999999",
    "address": "Cl. Jesús Bueno # 64 Dpto. 229",
    "document": {
      "type": "DNI",
      "number": "12345678"
    },
    "bankAccount": {
      "number": "11487349",
      "type": 1,
      "codeBank": "2"
    }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Peru: PEN to PEN

{
  "country": "PE",
  "amount": 1000,
  "currency": "PEN",
  "reason": "string",
  "destinationCurrency":"PEN",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
    "firstName": "Ornela",
    "lastName": "Olivera",
    "email": "ornelera@mail.com",
    "phone": "099999999",
    "address": "Cl. Jesús Bueno # 64 Dpto. 229",
    "document": {
      "type": "DNI",
      "number": "12345678"
    },
    "bankAccount": {
      "number": "11487349",
      "type": 1,
      "codeBank": "2"
    }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Peru: USD to USD

{
    "country": "PE",
    "amount": 1000,
    "currency": "USD",
    "reason": "string",
    "destinationCurrency":"USD",
    "reference": "PayOut34",
    "type": 2,
    "payee": {
      "firstName": "Ornela",
      "lastName": "Olivera",
      "email": "ornelera@mail.com",
      "phone": "099999999",
      "address": "Cl. Jesús Bueno # 64 Dpto. 229",
      "document": {
        "type": "DNI",
        "number": "12345678"
      },
      "bankAccount": {
        "number": "11487349",
        "type": 1,
        "codeBank": "2"
      }
    },
    "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Uruguay: USD to UYU

{
  "country": "UY",
  "amount": 1000,
  "currency": "USD",
  "destinationCurrency":"UYU",
  "reason": "string",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
    "firstName": "Daniel",
    "lastName": "Lorenzo",
    "email": "danielzo@mail.com",
    "phone": "999999999",
    "address": "12900 Montevideo",
    "document": {
      "type": "CI",
      "number": "38067788"
    },
     "bankAccount": {
      "number": "1234567",
      "type": 2,
      "codeBank": "113"
    }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Uruguay: UYU to UYU

{
  "country": "UY",
  "amount": 1000,
  "currency": "UYU",
  "reason": "string",
  "destinationCurrency":"UYU",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
    "firstName": "Daniel",
    "lastName": "Lorenzo",
    "email": "danielzo@mail.com",
    "phone": "999999999",
    "address": "12900 Montevideo",
    "document": {
      "type": "CI",
      "number": "38067788"
    },
        "bankAccount": {
      "number": "1234567",
      "type": 2,
      "codeBank": "113"
    }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Uruguay: USD to USD

{
  "country": "UY",
  "amount": 1000,
  "currency": "USD",
  "destinationCurrency": "USD",
  "reason": "string",
  "reference": "PayOut34",
  "type": 2,
  "payee": {
      "firstName": "Daniel",
      "lastName": "Lorenzo",
      "email": "danielzo@mail.com",
      "phone": "999999999",
      "address": "12900 Montevideo",
      "document": {
          "type": "CI",
          "number": "38067788"
      },
      "bankAccount": {
          "number": "1234567",
          "type": 2,
          "codeBank": "113"
      }
  },
  "notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}

Info

For corporate payouts, use companyName instead of firstName and lastName. Example "companyName":"Google LLC"

Responses

Ok: HttpCode 200.
Message received correctly, at this point the Payout starts to be processed.

Response body

{
    "payoutId": 145,
    "status": 5,
    "statusDescription": "Received",
    "reference": "PayOut34",
    "errors": []
}

Where:

Field	Description
`payoutId`	Internal identifier of the Payout.
`status`	Internal code of the current status of the Payout.
`statusDescription`	Current status of the Payout. Refer to this article to learn more about Payout status.
`reference`	Unique identifier of the Payout you defined when you requested the Payout.
`errors`	Errors that may appear. Find the possible errors here.

BadRequest: HttpCode HttpCode 400.
The validation of the message failed, and the Payout is not created.

Response body

{
    "errors": [
        {
            "ErrorCode": "ExactLengthValidator",
            "PropertyName": "Country",
            "Message": "'Country' must be 2 characters in length. You entered 1 characters."
        }
    ],
    "statusCode": 400
}

Unauthorized: HttpCode 401.
Authorization error.
Conflict - Declined: HttpCode HttpCode 409.
The validation of the message was successful, but the Payout is Declined due to business rules.

Response body

{
    "payoutId": 493945,
    "status": 8,
    "statusDescription": "Declined",
    "reference": "QA-538",
    "error": {
        "errorCode": 812,
        "message": "Declined by validation for document"
    }
}

Obtaining a Payout

This method allows you to retrieve the information of a Payout. You can retrieve the Payouts using the generated identifier (ID) or the reference you provided when requesting the Payout.

Request URL

You must invoke a GET request to the following URLs according to your needs.

Production: https://payout-api.bamboopayment.com/api/payout
Stage: https://payout-api.stage.bamboopayment.com/api/payout

To get the payout, include the following endpoints according to your needs.

Using Payout ID: {{URL}}/api/payout/{{PayoutID}}
Using Payout Reference: {{URL}}/api/payout/reference/{{PayoutReference}}

Response parameters

Parameter	Format	Description
`payoutId`	`long`	Internal identification of the Payout. (Max. 19 characters)
`reference`	`string`	Unique identifier of the Payout you defined when you requested the Payout.
`isoCountry`	`string`	ISO code of the country in format `ISO 3166-2`.
`created`	`date`	Date and time when the Payout was requested.
`lastUpdate`	`date`	Date and time of the last update of the Payout.
`status`	`integer`	Internal code of the current status of the Payout.
`statusDescription`	`string`	Current status of the Payout. Refer to this article to learn more about Payout status.
`errorCode`	`string`	Internal code of the error for the declined Payout. Find the possible errors here.
`errorDescription`	`string`	Error description for declined Payouts.
`amount`	`object`	Value and currency requested in the Payout.
`localAmount`	`object`	Value and currency requested in the Payout in local currency.
`exchangeRate`	`numeric`	Conversion value used in the Payout.
`payee`	`object`	Information of the recipient or beneficiary of the Payout.

Response example

{
    "payoutId": 1100,
    "reference": "QA-545",
    "isoCountry": "CO",
    "created": "2023-06-02T15:15:34.475614Z",
    "lastUpdate": "2023-06-02T15:20:18.1507484Z",
    "status": 1,
    "statusDescription": "Paid",
    "errorCode": null,
    "errorDescription": null,
    "amount": {
        "value": 10.0,
        "isoCurrency": "USD"
    },
    "localAmount": {
        "value": 42843.0,
        "isoCurrency": "COP"
    },
    "exchangeRate": 4394.23,
    "payee": {
        "firstName": "Paul",
        "lastName": "Doe",
        "email": "pauld@test.com",
        "phone": "099999999",
        "address": "address",
        "document": {
            "number": "11111111",
            "type": "CC"
        }
    }
}

Info

In payout for company, you will receive the field companyName instead of firstName and lastName.

Last modified November 18, 2024