One-Shot Payments

Learn how to make one-time payments with BreB Biometrics. With this payment method, users can pay by selecting one BreB key and using their device biometrics to complete a payment.

UX Flow


Request parameters

FieldTypeDescriptionRequired
amountNumberAmount to be charged.Yes
currencyStringCOP

Transaction currency in ISO 4217.
Yes
countryStringCO

Transaction country in ISO 3166.
Yes
payment_method_idStringQF

ID of the selected payment method.
Yes
payment_method_flowStringREDIRECTYes
Payer Object
payer.nameStringName of the payer.No
payer.emailStringEmail of the payer.No
payer.phoneStringPhone of the payer.Yes
payer.document_typeStringCC: Cédula de ciudadanía → Citizenship ID card / National ID card
CE: Cédula de Extranjería → Foreigner ID card
NUIP: Número único de identificación → Unique identification number
PPT: Permiso de Protección Temporal → Temporary Protection Permit
NIT: Número de Identificación Tributaria, sin dígito de verificación → Tax Identification Number, without check digit
PEP: Permiso Especial de Permanencia → Special Permit of Permanence
PAS: Número de Pasaporte → Passport number
TDI: Tarjeta de identidad → Identity card (for minors)

No

If not detailed, it will be required to the user in the redirect flow.

payer.documentNumberDocument number of the payer

No

If not detailed, it will be required to the user in the redirect flow.

order_idNumberID of the capture given by the merchant in their system. Think of it as an external ID of the capture.No
notification_urlString (max. 200)Notifications will be sent on every change of status to the notification_url specified by the merchant.Yes
callback_urlStringURL where the user will be redirected after approval of the transaction.Yes

Example

URL Selector with Opacity
Post

{
  "amount": 30000,
  "currency": "COP",
  "country": "CO",
  "payment_method_id": "QO",
  "payment_method_flow": "REDIRECT",
  "payer": {
    "document": "123456789",
    "document_type": "CC",
    "phone": "3001112233"
  },
  "order_id": "12345678",
  "notification_url": "https://merchant.com/payment_notifications",
  "callback_url": "https://merchant.com/breb/payment_callback"
}
{
  "id": "D-4-41f8628f-b6ec-4c02-96d5-c5b03cac7cb4",
  "amount": 30000,
  "currency": "COP",
  "payment_method_id": "QO",
  "payment_method_type": "TICKET",
  "payment_method_flow": "REDIRECT",
  "country": "CO",
  "created_date": "2025-09-10T20:37:20.000+0000",
  "status": "PENDING",
  "status_detail": "The payment is pending.",
  "status_code": "100",
  "order_id": "12345678",
  "notification_url": "https://merchant.com/payment_notifications",
  "redirect_url": "https://pay.dlocal.com/gmf-apm/payments/D-4-41f8628f-b6ec-4c02-96d5-c5b03cac7cb4"
}
{
  "id": "D-4-41f8628f-b6ec-4c02-96d5-c5b03cac7cb4",
  "amount": 30000,
  "status": "PAID",
  "status_detail": "The payment was paid.",
  "status_code": "200",
  "currency": "COP",
  "country": "CO",
  "payment_method_id": "QO",
  "payment_method_type": "TICKET",
  "payment_method_flow": "REDIRECT",
  "payer": {
    "document": "123456789",
    "document_type": "CC",
    "phone": "3001112233"
  },
  "order_id": "12345678",
  "notification_url": "https://merchant.com/payment_notifications",
  "callback_url": "https://merchant.com/breb/payment_callback",
  "created_date": "2025-09-10T20:37:20.000+0000"
}

Did this page help you?