Preview de Payout
El API de Payouts permite solicitar múltiples pagos utilizando el saldo disponible en su cuenta.
Preview del Payout
El método de Preview del Payout le permite mostrar el valor final recibido por el beneficiario y la fecha prevista en la que recibirá el dinero.
Advertencia
El Preview del Payout es meramente informativo y no congela el tipo de cambio, el cual se congela al solicitar el Payout.
URL del Request
Debe invocar un request POST a las siguientes URL de acuerdo con sus necesidades.
- Producción:
https://payout-api.bamboopayment.com/api/payout/preview - Stage:
https://payout-api.stage.bamboopayment.com/api/payout/preview
Parámetros del Request
La siguiente tabla muestra los parámetros obligatorios y opcionales para el Preview del Payout.
| Campo | Tipo | ¿Obligatorio? | Descripción | |
|---|---|---|---|---|
amount | number | Sí | Monto del Payout, el formato tiene dos dígitos decimales. Ejemplo 100 => $ 1,00. | |
destinationCountryIsoCode | string(2) | Sí | Código ISO del país en formato ISO 3166-2.Listado de países disponibles de Payouts. | |
destinationCurrencyIsoCode | string(3) | Sí * | Código ISO de la moneda de destino. Consulte aquí la lista de monedas | |
originalCurrencyIsoCode | string(3) | Sí | Código ISO de la moneda de origen. Consulte aquí la lista de monedas |
* Si no se proporciona el parámetro, el sistema utilizará por defecto la moneda del país de destino (parámetro destinationCountryIsoCode)
Ejemplo del Request
{
"amount": 1000,
"destinationCountryIsoCode": "CO",
"destinationCurrencyIsoCode": "COP",
"originalCurrencyIsoCode": "USD"
}Parámetros del Response
| Parámetro | Formato | Descripción |
|---|---|---|
amountInOrignalCurrency | number | Valor solicitado en el Preview del Payout. |
fee | number | Monto cobrado por Bamboo para porcesar el Payout. Usted o el beneficiario pueden asumir la tasa de acuerdo con su contrato. |
amountToBeSentInOrignalCurrency | number | Monto a ser enviado al Beneficiario, el cual se calcula como la diferencia entre amountInOrignalCurrency y fee. |
exchangeRate | number | Valor de conversión entre la moneda origen y destino. Este valor incluye hasta 5 dígitos decimales. |
amountToBeSentInLocalCurrency | number | Monto que va a recbir el Beneficiario, el cual se calcula multiplicando amountToBeSentInOriginalCurrency por exchangeRate. |
expectedPaymentDate | datetime | Indica la fecha estimada de pago. |
validUntil | datetime | Indica la hora hasta que va estar fijo el tipo de cambio, luego de la hora indicada el tipo de cambio puede modificarse. El horario que muestra es UTC-0. |
errors | object | Errores que pueden aparecer. Los códigos de error para este método empiezan por 6.Encuentre los posibles errores aquí. |
errors → ErrorCode | string | Código interno del error. Encuentra los posibles errores aquí. |
errors → PropertyName | string | Propiedad que provocó el error. |
errors → Message | string | Descripción del error. |
Ejemplo del Response
{
"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
}