Crear un Payout
Solicitud del Payout
Este método le permite solicitar uno o más Payouts utilizando los fondos depositados en su cuenta.
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
- stage:
https://payout-api.stage.bamboopayment.com/api/payout
Parámetros del Request
La siguiente tabla muestra los parámetros obligatorios y opcionales para crear Payouts para todos los países.
Campo | Tipo | ¿Obligatorio? | Descripción | |
---|---|---|---|---|
country | string(2) | Sí | Código ISO del país en formato ISO 3166-2 .Listado de países disponibles de Payouts. | |
amount | integer | Sí | Monto del Payout, el formato tiene dos dígitos decimales. Ejemplo 100 => $ 1,00. | |
currency | string(3) | Sí | Código ISO de la moneda. Esta moneda debe coincidir con la configurada en su cuenta. Consulte aquí la lista de monedas. | |
reason | string | No | Descripción del Payout. | |
destinationCurrency | string(3) | Sí | Código ISO de la moneda en la que el beneficiario recibirá el pago. Este parámetro no es necesario para el modelo USD2L, y el sistema utilizará por defecto la moneda del país de destino cuando no se envíe. Esta moneda debe cumplir el modelo de su cuenta. Por ejemplo:
Consulte aquí la lista de monedas. | |
reference | string | Sí | Identificador único del Payout definido por usted. Asegúrese de que sea único. | |
type | integer | Sí | Tipo de Payout. Asigne cualquiera de los siguientes valores:
| |
InstantPaymentData → PixDocument | string | Sí1 | El número CPF/CNPJ del beneficiario configurado como clave PIX. El número de dígitos para CPF debe ser 11 y CNPJ debe ser 14. | |
InstantPaymentData → PixEmail | string | Sí1 | La dirección de correo electrónico del beneficiario configurado como clave PIX. Este parámetro debe ser una dirección de correo electrónico válida. | |
InstantPaymentData → PixPhone | string | Sí1 | El número de teléfono del beneficiario configurado como clave PIX. El número debe empezar por +55 . | |
InstantPaymentData → PixRandom | string | Sí1 | La clave aleatoria que el beneficiario ha generado como clave PIX. | |
notification_Url | string | No | Webhook para notificar el resultado del Payout. Para más información sobre la configuración de este webhook, consulte este artículo. | |
payee → FirstName | string | Sí3 | Nombre del Beneficiario. | |
payee → lastName | string | Sí3 | Apellido del Beneficiario. | |
payee → companyName | string | Sí3 | Nombre de la empresa. | |
payee → email | string | No | Dirección de correo electrónico del Beneficiario. | |
payee → phone | string | No | Número de teléfono del Beneficiario. | |
payee → nationalitiCode | string | No | País de nacionalidad del beneficiario. Indicar country ISO code 2 dígitos. | |
payee → BirthDay | Date Time | No | Fecha de nacimiento del beneficiario. Formato “YYYY-MM-DD”. | |
payee → address | string | No | Dirección del Beneficiario. | |
Location → City | string | Sí5 | Ciudad de residencia del beneficiario. | |
Location → address | string | Sí5 | Dirección de residencia del beneficiario. | |
Location → zipCode | string | No | Código postal de residencia del beneficiario. | |
payee → document → type | string | Sí | Tipo de documento del Beneficiario. Encuentre la lista de documentos aquí. | |
payee → document → number | string | Sí | Número de documento del Beneficiario. | |
payee → bankaccount → number | string | Sí2 | Número de cuenta del Beneficiario. Tenga en cuenta las siguientes consideraciones:
| |
payee → bankaccount → type | integer | Sí2 | Tipo de cuenta del Beneficiario. Asigne 1 para Cuenta corriente y 2 para Cuenta de ahorros. | |
payee → bankaccount → codebank | string | Sí2 | Código del banco del Beneficiario. Puede obtener la lista de bancos de un país determinado utilizando el método Obtener listado de bancos. También, puede encontrar el listado de bancos. | |
payee → bankaccount → Swift | string | Sí4 | Código de ruteo internacional. | |
payee → bankaccount → Branch | string | Sucursal bancaria del Beneficiario. | ||
Remitter → fisrtName | string | Sí4 | Nombre del Remitente. | |
Remitter → lastName | string | Sí4 | Apellido del Remitente. | |
Remitter → companyName | string | Sí4 | Nombre de la persona jurídica (empresa) Remitente. | |
Remitter → birthday | date time | No | Fecha de nacimiento del Remitente. | |
Remitter → CountryIsoCode | string | No | País de residencia del Remitente. | |
Remitter → location → City | string | No | Ciudad del Remitente. | |
Remitter → location → Address | string | Sí4 | Dirección del Remitente. | |
Remitter → location → ZipCode | string | No | Código Postal de Remitente. |
1 Sólo aplica para Brasil usando Transferencia Bancaria Instantánea. En caso contrario, el objeto payee.InstantPaymentData
y sus parámetros no deben estar presentes en el request.
2 Cuando utilice Transferencias Bancarias, estos parámetros son obligatorios para TODOS los países. Para Transferencias Bancarias Instantáneas en Brasil, el objeto payee.bankaccount
y sus parámetros no deben estar presentes en el request.
3 Son mandatorios los campos firstName
y lastName
para persona física y companyName
para persona jurídica (empresa). Si se envía un payout para empresa solo se tiene que completar el campo companyName
, y si se envía un payout a una persona física solo se tienen que completar los campos firstName
y lastName
.
Importante: Los campos firstName
y lastName
no soportan ni números ni caracteres especiales, solo letras. El campo companyName
sí acepta todo tipo de caracteres alfanuméricos.
4 _Estos campos son obligatorios para transferencias bancarias SOLAMENTE a los siguientes países:
Bosnia y Herzegovina, Bulgaria, Costa Rica, República Dominicana, Egipto, Guatemala, Israel, Nicaragua, Noruega, Paraguay y Turquía. _
5 Estos campos son obligatorios solamente para transferencias bancarias a Egipto.
Ejemplo del Request
Consulte la pestaña correspondiente de acuerdo con el país del beneficiario.
Argentina: De USD a 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: De ARS a 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"
}
Como se mencionó anteriormente, el objeto payee.bankaccount
no debe estar presente en el request. Por lo tanto, al utilizar Transferencias Bancarias Instantáneas es necesario enviarlo de la siguiente manera:
Brasil: De USD a 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"
}
Brasil: BRL a 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 a 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 a 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 a 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 a 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"
}
México: USD a 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"
}
México: MXN a 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"
}
Perú: USD a 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": "12345678901234567890",
"type": 1,
"codeBank": "2"
}
},
"notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}
Perú: PEN a 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": "12345678901234567890",
"type": 1,
"codeBank": "2"
}
},
"notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}
Perú: USD a 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": "12345678901234567890",
"type": 1,
"codeBank": "2"
}
},
"notification_Url": "https://webhook.site/ebc46ace-94a1-4265-9d7f-d457d437a1b4"
}
Uruguay: USD a 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 a 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 a 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"
}
Bosnia y Herzegovina: USD a BAM
{
"country": "BA",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "DNI",
"number": "12345678901"
},
"bankAccount": {
"number": "BA393384002241452786",
"swift": "UNCRBA22XXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Bulgaria: USD a BGN
{
"country": "BG",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "BULSTAT",
"number": "ABC123456789"
},
"bankAccount": {
"number": "BG80BNBG96611020345678",
"swift": "BNBGBGSFXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Costa Rica: USD a CRC
{
"country": "CR",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "CI",
"number": "951951258"
},
"bankAccount": {
"number": "CR23015108410026012345",
"swift": "BNCRCRSJXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
República Dominicana: USD a DOP
{
"country": "DO",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "CI",
"number": "12345678901"
},
"bankAccount": {
"number": "DO88BRRD00000000001630622734",
"swift": "BRRDDOSDXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Egipto: USD a EGP
{
"country": "EG",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "DNI",
"number": "ABC123456789"
},
"bankAccount": {
"number": "EG380019000500000000263180002",
"swift": "NBADEGCAXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Guatemala: USD a GTQ
{
"country": "GT",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "DNI",
"number": "ABC123456789"
},
"bankAccount": {
"number": "GT82TRAJ01020000001210029690",
"swift": "TRAJGTGCXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Israel: USD a ILS
{
"country": "IL",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "PASSPORT",
"number": "ABC123456789"
},
"bankAccount": {
"number": "IL620108000000099999999",
"swift": "LUMIILITTLV",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Nicaragua: USD a NIO
{
"country": "NI",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "RUC",
"number": "DEF987654321"
},
"bankAccount": {
"number": "12345678901234567890123456789012345",
"swift": "UNCRBA22XXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Noruega: USD a NOK
{
"country": "NO",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "PASSPORT",
"number": "ABC123456789"
},
"bankAccount": {
"number": "NO9386011117947",
"swift": "DABANO22XXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Paraguay: USD a PYG
{
"country": "PY",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "RUC",
"number": "GHI555666777"
},
"bankAccount": {
"number": "1459842747",
"swift": "BGNBPYPXXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Turquía: USD a TRY
{
"country": "TR",
"amount": 508,
"currency": "USD",
"reason": "string",
"reference": "reference",
"type": 2,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"email": null,
"phone": "099999999",
"nationalityCode": "AR",
"birthDay": "1996-11-04",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"type": "TCKN",
"number": "ABC123456789"
},
"bankAccount": {
"number": "TR220001234567890000000001",
"swift": "TRHBTR2AXXX",
"type": 0,
"codeBank": null,
"branch": null
}
},
"remitter": {
"firstName": "Ari",
"lastName": "Carba",
"birthDay": "1996-11-04",
"companyName": "michifusis",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"countryIsoCode": "AR"
},
"notification_Url": "null"
}
Info
Para enviar el payout para persona jurídica, reemplazar los campos firstName
y lastName
por companyName
.
Ejemplo "companyName":"Google LLC"
Responses
Ok
: HttpCode200
.
Mensaje recibido correctamente, en este punto, el Payout empieza a ser procesado.
Response body
{
"payoutId": 145,
"status": 5,
"statusDescription": "Received",
"reference": "PayOut34",
"errors": []
}
Donde:
Campo | Descripción |
---|---|
payoutId | Identificador interno del Payout. |
status | Código interno del estado actual del Payout. |
statusDescription | Estado actual del Payout. Consulte este artículo para aprender más acerca de los estados de los Payouts. |
reference | Identificador único del Payout definido por usted cuando solicitó el Payout. |
errors | Errores que pueden aparecer. Encuentre los posibles errores aquí. |
BadRequest
: HttpCodeHttpCode 400
.
Falló la validación del mensaje (error en validación de datos) y el Payout queda en estado is not created.
Response body
{
"errors": [
{
"ErrorCode": "ExactLengthValidator",
"PropertyName": "Country",
"Message": "'Country' must be 2 characters in length. You entered 1 characters."
}
],
"statusCode": 400
}
También aplica cuando un campo obligatorio de la API no es ingresado.
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"Payee.Document": [
"The Document field is required."
]
},
"traceId": "00-0f34c73a204d3fece346911769356011-8e4519aef77c0652-00"
}
* `Unauthorized`: HttpCode `401`.
Error de autorización.
Conflict
-Declined
: HttpCodeHttpCode 409
.
La validación del mensaje fue exitosa pero, el Payout queda en estado Declinado debido a reglas de negocio.
Response body
{
"payoutId": 493945,
"status": 8,
"statusDescription": "Declined",
"reference": "QA-538",
"error": {
"errorCode": 812,
"message": "Declined by validation for document"
}
}
Obtener un Payout
Este método le permite traer la información de un Payout utilizando el identificador (ID) generado o la referencia que asignó cuando solicitó el Payout.
URL del Request
Debe invocar un request GET a las siguientes URL de acuerdo con sus necesidades.
- Producción:
https://payout-api.bamboopayment.com/api/payout
- Stage:
https://payout-api.stage.bamboopayment.com/api/payout
Para obtener el Payout, incluya los siguientes endpoints de acuerdo con sus necesidades.
- A través del ID del Payout:
{{URL}}/api/payout/{{PayoutID}}
- A través del ID de la referencia del Payout:
{{URL}}/api/payout/reference/{{PayoutReference}}
Parámetros del Response
Parámetro | Formato | Descripción |
---|---|---|
payoutId | long | Identificador interno del Payout. (Máx. 19 caracteres) |
reference | string | Identificador único del Payout definido por usted cuando solicitó el Payout. |
isoCountry | string | Código ISO del país en formato ISO 3166-2 . |
created | date | Fecha y hora de la solicitud del Payout. |
lastUpdate | date | Fecha y hora de la última actualización del Payout. |
status | integer | Código interno del estado actual del Payout. |
statusDescription | string | Estado actual del Payout. Consulte este artículo para aprender más acerca de los estados de los Payouts. |
errorCode | string | Código interno del error del Payout declinado. Encuentre los posibles errores aquí. |
errorDescription | string | Descripción del error del Payout declinado. |
amount | object | Valor y moneda solicitado en el Payout. |
localAmount | object | Valor y moneda solicitado en el Payout en moneda local. |
exchangeRate | numeric | Valor de conversión utilizado en el Payout. |
payee | object | Información del beneficiario del Payout. |
description | string | La descripción / razón ingresada en el request. |
Ejemplo del Response
{
"payoutId": 183967619655665472,
"reference": "ARI-763",
"isoCountry": "BA",
"created": "2025-05-22T15:41:39.0401892Z",
"lastUpdate": "2025-05-22T15:41:40.2559466Z",
"status": 8,
"statusDescription": "Declined",
"errorCode": "705",
"errorDescription": "Invalid origin currency ISO code",
"amount": {
"value": 5.08,
"isoCurrency": "EUR"
},
"localAmount": null,
"exchangeRate": null,
"payee": {
"firstName": "Ari",
"lastName": "Carba",
"companyName": "",
"email": "",
"phone": "099999999",
"location": {
"city": "city",
"address": "address",
"zipCode": "zip"
},
"document": {
"number": "2606876221",
"type": "PASSPORT"
}
},
"description": "string"
}
Info
En payouts para persona jurídica, se recibirá el campo companyName
en lugar de firstName
y lastName
.
