Payout Preview
The Payouts API allows you to request multiple payments using the balance available in your account.
Payout Preview
The Payout preview method allows you to show the final value received by the payee and the expected date when the payee will receive the money.
Warning
The Preview is for informational purposes only, and it does not freeze the exchange rate, which is frozen when you request the Payout.
Request URL
You must invoke a POST request to the following URLs according to your needs.
- Production:
https://payout-api.bamboopayment.com/api/payout/preview - Stage:
https://payout-api.stage.bamboopayment.com/api/payout/preview
Request parameters
The following table shows the mandatory and optional parameters for the Payout preview.
| Field | Type | Mandatory? | Description | |
|---|---|---|---|---|
amount | number | Yes | Amount of the Payout, the format has two digits for decimals. Example 100 => $ 1,00. | |
destinationCountryIsoCode | string(2) | Yes | ISO code of the country in the format ISO 3166-2.List of countries available for Payouts. | |
destinationCurrencyIsoCode | string(3) | Yes * | ISO code of the destination currency. Find the currencies list here | |
originalCurrencyIsoCode | string(3) | Yes | ISO code of the origin currency. Find the currencies list here |
* If the parameter is not provided, the system will default to the currency of the destination country (parameter destinationCountryIsoCode).
Request example
{
"amount": 1000,
"destinationCountryIsoCode": "CO",
"destinationCurrencyIsoCode": "COP",
"originalCurrencyIsoCode": "USD"
}Response parameters
| Parameter | Format | Description |
|---|---|---|
amountInOrignalCurrency | number | Value requested in the Payout preview. |
fee | number | Amount charged by Bamboo to process the Payout. You or the payee can assume the fee according to your contract. |
amountToBeSentInOrignalCurrency | number | The amount to be sent to the Payee, which is calculated as the difference between amountInOrignalCurrency and fee. |
exchangeRate | number | Conversion value between the origin and target currencies. This parameter includes up to 5 decimal places. |
amountToBeSentInLocalCurrency | number | The amount received by the payee, which is calculated by multiplying amountToBeSentInOriginalCurrency by exchangeRate. |
expectedPaymentDate | datetime | Indicates the estimated date of payment. |
validUntil | datetime | Indicates the time until the exchange rate will be fixed, after the indicated time the exchange rate can be changed. The time shown is UTC-0. |
errors | object | Errors that may appear. The error codes for this method start with 6.Find the possible errors here. |
errors → ErrorCode | string | Internal code of the error. Find the possible errors here. |
errors → PropertyName | string | Property that triggered the error. |
errors → Message | string | Error description. |
Response example
{
"amountInOrignalCurrency": 5.09,
"fee": 0,
"amountToBeSentInOrignalCurrency": 5.09,
"exchangeRate": 39.3664547250,
"amountToBeSentInLocalCurrency": 200.37,
"expectedPaymentDate": "2024-09-12T00:00:00Z",
"validUntil": "2024-09-10T15:19:17Z",
"error": null
}