Boleto

Aprenda a integrar su solución para procesar pagos con Boleto Bancario.

Info

El estado de la compra para Medios Alternativos de Pago permanecerá en Pending hasta que el cliente complete el pago.

Boleto Bancario

Boleto Bancário es un medio de pago popular en Brasil que permite pagar facturas y compras en línea sin necesidad de una tarjeta de crédito: Genera un código de barras único que puede ser imprimido o accedido a través de una plataforma digital y puede ser pagado en cualquier banco u oficina de pago autorizada.

Parámetros del Request

Para procesar pagos en efectivo, necesitas incluir campos específicos en tu solicitud. Para información sobre autenticación, idiomas de respuesta y parámetros básicos como monto y moneda, consulta el artículo sobre operación de compra.

Propiedad	Tipo	¿Obligatorio?	Descripción
`PaymentMethod`	`string`	Sí	Consulta el identificador en la tabla de Medios de pago.
`TargetCountryISO`	`string`	Sí	Indica el país destino.
`Customer` → `Email`	`string`	Sí	Correo electrónico del cliente.
`Customer` → `FirstName`	`string`	Sí	Nombre del cliente.
`Customer` → `LastName`	`string`	Sí	Apellido del cliente.
`Customer` → `DocumentType`	`string`	Sí	Tipo de documento del cliente. Consulte la tabla de tipos de documento para ver los posibles valores.
`Customer` → `DocumentNumber`	`string`	Sí	Número de documento del cliente.
`Customer` → `PhoneNumber`	`string`	No	Número de teléfono del cliente.
`Customer` → `Address` → `Country`	`string`	No	País del cliente.
`Customer` → `Address` → `State`	`string`	Sí	Estado del cliente.
`Customer` → `Address` → `City`	`string`	Sí	Ciudad del cliente.
`Customer` → `Address` → `AddressDetail`	`string`	No	Detalle de la dirección del cliente.
`Customer` → `Address` → `PostalCode`	`string`	Sí	Código postal del cliente. El código postal debe tener ocho dígitos; por ejemplo, `29018660`.
`MetaDataIn` → `PaymentExpirationInMinutes`	`numeric`	No	Configure el tiempo de expiración del pago a través de este campo, especificando la duración en minutos. Si no envía este campo, la API asignará un valor por defecto.
`MetadataIn.` → `AddressStreet`	`string`	Sí	Calle de la dirección del cliente.
`MetadataIn` → `AddressNumber`	`string`	Sí	Número, piso o apartamento de la dirección del cliente.
`MetadataIn` → `AddressDistrict`	`string`	Sí	Distrito de la dirección del cliente.

Ejemplo del Request

{
    "PaymentMethod": "BLT",
    "Order": "paymentID3022",
    "Amount": 20000,
    "Currency": "BRL",
    "Description": "Purchase Test",
    "MetaDataIn": {
        "PaymentExpirationInMinutes": "7200",
        "AddressStreet": "Avenida Anisio Fernandes Coelho",
        "AddressNumber": "661",
        "AddressDistrict": "PR"
    },
    "TargetCountryISO": "BR",
    "Customer": {
        "Address": {
            "AddressDetail": "Avenida Anisio Fernandes Coelho, 661 ",
            "PostalCode": "29060670",
            "City": "Vitoria",
            "State": "ES",
            "Country": "Brasil"
        },
        "FirstName": "Jhon",   
        "LastName": "Doe",
        "DocumentNumber": "47168892703",
        "DocumentType": "CPF.BR",
        "PhoneNumber": "3188060418",
        "Email": "john@mail.com"
    }
}

Parámetros del Response

En el Response, se encuentran los siguientes parámetros:

Propiedad	Tipo	Descripción
`Response` → `MetadataOut` → `PaymentCode`	`string`	Código de pago generado por Boleto Bancario
`Response` → `MetadataOut` → `PaymentBarCode`	`string`	Número del código de barras generado para completar el pago.
`Response` → `MetadataOut` → `PaymentBarCodeUrl`	`string`	URL de la página de pago. Usted puede redirigir al pagador a esta página para descargar el boleto.
`Response` → `MetadataOut` → `PaymentExpirationDate`	`date`	Fecha de expiración del pago. Formato DD/MM/AAAA HH:MM:SS.

Página de pago en Boleto

PrintScreen

Ejemplo del Response

{
    "TransactionId": "128635201747174176",
    "Result": "COMPLETED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2024-12-20T20:46:20.199",
    "AuthorizationDate": "2024-12-20T20:46:20.674",
    "AuthorizationCode": "",
    "Amount": 1000,
    "Currency": "BRL",
    "Installments": 1,
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/Purchase/128635201747174176",
    "MetadataOut": {
        "PaymentCode": "bd88102f813cface085ea4ac63038a65cd5378228be2d5694f67b8a83af45931",
        "PaymentBarCode": "10491814900000002009632034000900041179634666",
        "PaymentBarCodeUrl": "https://pagar.sandbox.goboleto.com/?hash=bd88102f813cface085ea4ac63038a65cd5378228be2d5694f67b8a83af45931",
        "PaymentExpirationDate": "09/01/2026 00:00:00"
    },
    "Action": null,
    "PaymentMethod": {
        "Brand": "Boleto",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "BankTransfer",
        "Expiration": null,
        "Last4": null
    }
}

Última modificación 20 de diciembre de 2024