Bre-B

Payment flow

The customer reaches the checkout page and selects Bre-B as the preferred payment option.
A Bre-B payment voucher is generated and displayed. The customer can scan the QR code or download it as an image.
On their banking application, the customer scan the QR code or upload the saved image.
The banking app shows the payment information so the customer can review and authorize the transaction.
Once the payment is approved, the merchant’s website receives the confirmation and completes the purchase flow.

Request parameters

The following parameters are required specifically for this payment method.
Refer to the Create a Purchase guide for authentication and global fields such as Amount, Currency, and Order.

Property	Type	Description
`PaymentMethod`	`string`	Must be `BBQ`. Refer to the Payment Methods table. Required.
`TargetCountryISO`	`string`	Country code. Must be CO.Required.
`Customer` → `Email`	`string`	Customer’s email address. Required.
`Customer` → `FirstName`	`string`	Customer’s first name. Recommended.
`Customer` → `LastName`	`string`	Customer’s last name. Recommended.
`Customer` → `DocumentType`	`string`	Use a valid value from the Document types tableRequired.
`Customer` → `DocumentNumber`	`string`	Customer’s Identification number. Document Types – Colombia.Required.
`Customer` → `PhoneNumber`	`string`	Customer phone number.Recommended.

Request example

To test this endpoint, use the API Reference or the Postman Collection

{
    "PaymentMethod": "BBQ",
    "Order": "CH2023-001",
    "TargetCountryISO": "CO",
    "Amount": 100100,
    "Currency": "COP",
    "Description":"Purchase Test",
    "Customer": {
        "Email": "[email protected]",
        "FirstName" : "John",
        "LastName": "Doe",
        "DocumentNumber" : "13394559358",
        "DocumentType": "NIT.CO",
        "PhoneNumber": "+573998764643"
    }
}

Response parameters

The API response returns the payment voucher information (QR code and payment key) required for the customer to complete the payment. The transaction is initially created with PENDING status. The final payment result is notified asynchronously through webhook notifications. For more details on the full response object, refer to the Response parameters section of the Purchase creation guide.

Property	Type	Description
`Base64QR`	`string`	Image of the QR code in Base64, for display on the checkout.
`PaymentCouponUrl`	`string`	Payment coupon URL (Voucher).
`PaymentExpirationDate`	`string`	Payment expiry date and time, format dd/MM/yyyy HH:mm (Only applies for Local currency)

Response example

{
    "TransactionId": "313343841237314912",
    "Result": "COMPLETED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2026-05-14T15:56:33.463",
    "AuthorizationDate": "2026-05-14T15:56:45.489",
    "AuthorizationCode": null,
    "Amount": 100100,
    "Currency": "COP",
    "Installments": 1,
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/v3/api/transaction/313343841237314912",
    "MetadataOut": {
        "Base64Qr": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
        "PaymentCouponUrl": "https://voucher.stage.bamboopayment.com/vouchers/breb/voucher_313343841237314912_20260514155643.html",
        "PaymentExpirationDate": "14/05/2026 23:59"
    },
    "Action": null,
    "PaymentMethod": {
        "Brand": "Bre-B",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "BankTransfer",
        "Expiration": null,
        "Last4": null
    }
}